Skip to content

Commit 4ff3d71

Browse files
tucktuckg00seclaude
andcommitted
Add install instructions to README, flatten release zip structure
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2aa9841 commit 4ff3d71

2 files changed

Lines changed: 55 additions & 3 deletions

File tree

.github/workflows/release.yml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ jobs:
2121

2222
- name: Package
2323
run: |
24-
7z a INTERSECT-Windows.zip ./build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 ./build/Intersect_artefacts/Release/Standalone/INTERSECT.exe
24+
mkdir staging
25+
cp -r build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 staging/
26+
cp build/Intersect_artefacts/Release/Standalone/INTERSECT.exe staging/
27+
cd staging && 7z a ../INTERSECT-Windows.zip *
2528
2629
- uses: actions/upload-artifact@v4
2730
with:
@@ -48,7 +51,10 @@ jobs:
4851

4952
- name: Package
5053
run: |
51-
zip -r INTERSECT-Linux.zip build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 build/Intersect_artefacts/Release/Standalone/INTERSECT
54+
mkdir staging
55+
cp -r build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 staging/
56+
cp build/Intersect_artefacts/Release/Standalone/INTERSECT staging/
57+
cd staging && zip -r ../INTERSECT-Linux.zip .
5258
5359
- uses: actions/upload-artifact@v4
5460
with:
@@ -70,7 +76,11 @@ jobs:
7076

7177
- name: Package
7278
run: |
73-
zip -r INTERSECT-macOS.zip build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 build/Intersect_artefacts/Release/Standalone/INTERSECT.app build/Intersect_artefacts/Release/AU/INTERSECT.component
79+
mkdir staging
80+
cp -r build/Intersect_artefacts/Release/VST3/INTERSECT.vst3 staging/
81+
cp -r build/Intersect_artefacts/Release/Standalone/INTERSECT.app staging/
82+
cp -r build/Intersect_artefacts/Release/AU/INTERSECT.component staging/
83+
cd staging && zip -r ../INTERSECT-macOS.zip .
7484
7585
- uses: actions/upload-artifact@v4
7686
with:

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,48 @@ A time-stretching intersecting sample slicer plugin with independent per-slice p
2222
- **Full state recall** — all parameters, slices, and audio data saved/restored with the DAW session
2323
- **Dark industrial theme** — styled popup menus and controls
2424

25+
## Install
26+
27+
Download the latest release zip for your platform from the [Releases](https://github.com/tucktuckg00se/INTERSECT/releases) page and extract it.
28+
29+
### Windows
30+
31+
Copy `INTERSECT.vst3` to your VST3 folder:
32+
33+
```
34+
C:\Program Files\Common Files\VST3\
35+
```
36+
37+
Or run `INTERSECT.exe` as a standalone app.
38+
39+
### macOS
40+
41+
Copy `INTERSECT.vst3` to your VST3 folder:
42+
43+
```
44+
~/Library/Audio/Plug-Ins/VST3/
45+
```
46+
47+
For AU, copy `INTERSECT.component` to:
48+
49+
```
50+
~/Library/Audio/Plug-Ins/Components/
51+
```
52+
53+
Or run `INTERSECT.app` as a standalone app.
54+
55+
### Linux
56+
57+
Copy `INTERSECT.vst3` to your VST3 folder:
58+
59+
```
60+
~/.vst3/
61+
```
62+
63+
Or run the `INTERSECT` standalone binary directly.
64+
65+
After installing, rescan plugins in your DAW to pick up INTERSECT.
66+
2567
## Build
2668

2769
Requires CMake 3.22+ and a C++20 compiler.

0 commit comments

Comments
 (0)