Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeoliphant authored May 15, 2024
1 parent 2b3d241 commit cd7d793
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ This is what it looks like:

Stompbox currently can be run in the following ways:

* Headless on Linux (I use it on a [Raspberry Pi based pedalboard](https://www.youtube.com/watch?v=2I_bxxzQs2s)
* Remote UI on Windows or Android (Android currently not functional, but will be fixed soon)
* Headless on Linux (I use it on a [Raspberry Pi based pedalboard](https://www.youtube.com/watch?v=2I_bxxzQs2s))
* Remote UI on Windows or Android
* Standalone app on Windows
* VST3 plugin on Windows

Expand All @@ -46,3 +46,15 @@ Simply extract the .zip file and copy the resulting folder to "C:\Program Files\

Files, such as NAM models, impulse responses, etc. go in your local user roaming AppData folder. Go to "%APPDATA%" in file explorer, and you should see a "stompbox" folder after the VST has been loaded at least once.

# Building From Source

Make sure you clone this github repo recursively:

```bash
git clone --recurse-submodules https://github.com/mikeoliphant/StompboxUI
```

Building should be straightforward using Visual Studio.

**NOTE:** Build and run the "StompboxImageProcessor" project first - it creates texture assets that are required for the main build.

0 comments on commit cd7d793

Please sign in to comment.