Skip to content

Commit

Permalink
Update the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Bartlett committed May 17, 2024
1 parent dd4d99b commit b3b84f4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For now, you'll need to be using Linux to have the tools work for you, though th
why, in the future, we can't get the tools running on Windows and Mac.

## Installation
Download the [latest version of the SDK bundle](../../releases/download/v0.2.1/faust-stratus-v0.2.1.zip) to your local computer
Download the [latest version of the SDK bundle](../../releases/download/v0.3.0/faust-stratus-v0.3.0.zip) to your local computer
(NOT the Stratus pedal) and un-zip it into a folder of your choosing.

You can install this SDK in either of two places - or both!
Expand Down Expand Up @@ -237,10 +237,13 @@ for a while - _don't panic_ - that's a good sign - it's updating your current ch
new effect library!

## Using the Python wrapper
The Python interface is installed on the Stratus by the `install-sdk` command.
The Python interface is installed locally by the `install-local` command, and on the Stratus by the
`install-sdk` command.

This is very useful for devising tests for your effect that closely emulate how the Stratus
will interact with your effect without actually having to build the UI yet.
will interact with your effect without actually having to build the UI yet. In particular, you
can build the effect _locally_ and test it with Python without even requiring you Stratus pedal
to be accessed.

You don't have to do anything special to get the Python interface to work - the effect libraries
generated by the toolkit are by default compatible with the Python wrapper
Expand Down

0 comments on commit b3b84f4

Please sign in to comment.