Merge branch 'master' of https://github.com/mikeoliphant/StompboxUI

mikeoliphant · Jun 13, 2024 · 7470534 · 7470534
2 parents 16d7cd4 + a054196
commit 7470534
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 4 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -51,14 +51,14 @@ jobs:
         msbuild .\StompboxUI.sln /t:StompboxImageProcessor /p:Configuration="Release" 
         StompboxImageProcessor\bin\Release\net8.0-windows\StompboxImageProcessor.exe
         
-    - name: Run MSBuild
+    - name: Run MSBuild for VST Plugin
       working-directory: ${{github.workspace}}
       run: msbuild .\StompboxUI.sln /t:StompboxPlugin /p:Configuration=Release
 
     - name: Add Plugin Archive
       run: Compress-Archive -Path ${{github.workspace}}\StompboxPlugin\bin\Release\net8.0-windows\* -Destination StompboxVST3Plugin.zip
 
-    - name: Upload Release Asset
+    - name: Upload Plugin Asset
       uses: actions/upload-release-asset@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -67,3 +67,20 @@ jobs:
         asset_path: ./StompboxVST3Plugin.zip
         asset_name: StompboxVST3Plugin.zip
         asset_content_type: application/zip
+
+    - name: Run MSBuild for Windows Remote
+      working-directory: ${{github.workspace}}
+      run: msbuild .\StompboxUI.sln /t:StompboxRemote /p:Configuration=Release
+
+    - name: Add Windows Remote Archive
+      run: Compress-Archive -Path ${{github.workspace}}\StompboxRemote\bin\Release\net8.0-windows\* -Destination StompboxRemote.zip
+
+    - name: Upload Windows Remote Asset
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ needs.create_release.outputs.upload_url }}
+        asset_path: ./StompboxRemote.zip
+        asset_name: StompboxRemote.zip
+        asset_content_type: application/zip        
diff --git a/README.md b/README.md
@@ -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
 
@@ -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.
+