Skip to content

Commit 4fe1572

Browse files
author
Nathan Ho
authored
add more specific instructions in README
1 parent 47f2d23 commit 4fe1572

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ plugin-example/01-BoringMixer/$ mkdir build && cd build
1818
plugin-example/01-BoringMixer/build/$ cmake -DSC_PATH=/path/to/sc3source/ ..
1919
```
2020

21-
If no `SC_PATH` is provided the build system assumes the SuperCollider include files in `/usr/include/SuperCollider/`.
21+
Here, `/path/to/sc3source/` is the path to a directory of the SuperCollider *source code*. The source code version should match your SuperCollider app version. Slight differences will probably be tolerated, but if they're too far apart you will get an "API version mismatch" error when you boot the server.
22+
23+
The path should contain a file at `include/plugin_interface/SC_PlugIn.h`. If you get a warning that `SC_PlugIn.h` could not be found, then `SC_PATH` is not set correctly.
24+
25+
If no `SC_PATH` is provided, the build system assumes the SuperCollider include files in `/usr/include/SuperCollider/`.
2226

2327
```shell
2428
plugin-example/01-BoringMixer/build/$ make
@@ -29,16 +33,16 @@ WARNING: on OSX, if you want to install into `CMAKE_INSTALL_PREFIX`, you have to
2933

3034
## Installing
3135

32-
Copy the folder you want to install to your Extensions folder. You can find out which one that is by evaluating
36+
You can install each folder -- or the entire repository -- as you would a quark: `Quarks.gui` => `Install a folder`.
37+
38+
Alternatively, you can copy, move, or symbolic link the folder into your Extensions folder. You can find out which one that is by evaluating
3339

3440
```
3541
Platform.userExtensionDir
3642
```
3743

38-
from within SuperCollider. Alternatively, you may install the extensions system-wide by copying to
44+
from within SuperCollider. Alternatively, you may install the plugin(s) system-wide by copying to
3945

4046
```
4147
Platform.systemExtensionDir
4248
```
43-
44-
Tip: On OSX and Linux, it might be more convenient to use a symbolic link rather than copying or moving the directory.

0 commit comments

Comments
 (0)