ASCEE/lasp
ASCEE/lasp
5
1
Fork 0
Code Issues 5 Pull Requests Actions Releases 14 Activity

Updated readme
All checks were successful
Building, testing and releasing LASP if it has a tag / Build-Test-Ubuntu (push) Successful in 2m55s
Details
Building, testing and releasing LASP if it has a tag / Release-Ubuntu (push) Has been skipped
Details

Browse Source
This commit is contained in:
Anne de Jong 2023-10-24 19:49:56 +02:00
parent e4f887dc5b
commit a7b219a1e1
1 changed files with 7 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -84,7 +84,7 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will
- `$ cd lasp` - `$ cd lasp`
- `pip install -e .` - `pip install -e .`
# Installation - (x86_64) Windows (with WinPython), build with MSYS2 # Installation - (x86_64) Windows (with WinPython), build with MSYS2 (NOT YET UPDATED!!)
## Prerequisites ## Prerequisites
@ -117,7 +117,11 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will
# Documentation # Documentation
In directory: ## Online
[Online LASP documentation](https://lasp.ascee.nl/).
## In directory
`$ sudo apt install doxygen graphviz` `$ sudo apt install doxygen graphviz`
`$ pip install doxypypy` `$ pip install doxypypy`
@ -130,21 +134,7 @@ This will build the documentation. It can be read by:
`$ <YOUR-BROWSER> doc/html/index.html` `$ <YOUR-BROWSER> doc/html/index.html`
Or via docker: # Usage
`$ docker build -t lasp_ascee_nl:latest .`
## Install
For an editable install (while developing):
- `$ pip3 install --prefix=$HOME/.local -e .`
To install locally, for a fixed version:
- `$ pip3 install --prefix=$HOME/.local`
## Usage
- See examples directories for IPython notebooks. - See examples directories for IPython notebooks.
- Please refer to the [documentation](https://lasp.ascee.nl/) for features. - Please refer to the [documentation](https://lasp.ascee.nl/) for features.