Skip to content

Commit 4e0f8d9

Browse files
author
Nathan Ho
authored
clarify that you don't need to recompile SC
1 parent 34cbfbe commit 4e0f8d9

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Beyond this repository, the reader is encouraged to look at [sc3-plugins](https:
1717

1818
## Compiling
1919

20+
Before you can compile any plugin, you will need a copy of the SuperCollider *source code* (NOT the app itself). 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.
21+
22+
You will not need to recompile SuperCollider itself. You only need the source code to get the C++ headers.
23+
2024
This is how you build one of the examples in this directory. The examples are kept separate with duplicated code so that you can simply copy out a directory to start your own ugen. **Currently, this build system is missing two things: Windows and supernova. Sorry, we're working on it...**
2125

2226
CMake dumps a lot of files into your working directory, so you should always start by creating the `build/` directory:
@@ -25,14 +29,13 @@ CMake dumps a lot of files into your working directory, so you should always sta
2529
example-plugins/01a-BoringMixer/$ mkdir build
2630
example-plugins/01a-BoringMixer/$ cd build
2731
```
28-
2932
Next, we run CMake and tell it where the SuperCollider headers are to be found (don't forget the `..`!):
3033

3134
```shell
3235
example-plugins/01a-BoringMixer/build/$ cmake -DSC_PATH=/path/to/sc3source/ ..
3336
```
3437

35-
Here, `/path/to/sc3source/` is the path to a directory of the SuperCollider *source code* (NOT the app itself). 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.
38+
Here, `/path/to/sc3source/` is the path to the source code. Once again, this is the *source code*, not the app itself.
3639

3740
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. If no `SC_PATH` is provided, the build system assumes the SuperCollider include files in `/usr/include/SuperCollider/`.
3841

0 commit comments

Comments
 (0)