Updated readme
This commit is contained in:
parent
e4f887dc5b
commit
a7b219a1e1
24
README.md
24
README.md
@ -84,7 +84,7 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will
|
||||
- `$ cd lasp`
|
||||
- `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
|
||||
|
||||
@ -117,7 +117,11 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will
|
||||
|
||||
# Documentation
|
||||
|
||||
In directory:
|
||||
## Online
|
||||
|
||||
[Online LASP documentation](https://lasp.ascee.nl/).
|
||||
|
||||
## In directory
|
||||
|
||||
`$ sudo apt install doxygen graphviz`
|
||||
`$ pip install doxypypy`
|
||||
@ -130,21 +134,7 @@ This will build the documentation. It can be read by:
|
||||
|
||||
`$ <YOUR-BROWSER> doc/html/index.html`
|
||||
|
||||
Or via docker:
|
||||
|
||||
`$ 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
|
||||
# Usage
|
||||
|
||||
- See examples directories for IPython notebooks.
|
||||
- Please refer to the [documentation](https://lasp.ascee.nl/) for features.
|
||||
|
Loading…
Reference in New Issue
Block a user