Skip to content

Commit e8a23b5

Browse files
author
Nathan Ho
authored
README: add note about dev workflow
1 parent 4711fb0 commit e8a23b5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,13 @@ The path should contain a file at `include/plugin_interface/SC_PlugIn.h`. If you
2424

2525
If no `SC_PATH` is provided, the build system assumes the SuperCollider include files in `/usr/include/SuperCollider/`.
2626

27+
After setting `SC_PATH`, simply build using `make`:
28+
2729
```shell
2830
plugin-example/01-BoringMixer/build/$ make
29-
plugin-example/01-BoringMixer/build/$ make install
3031
```
3132

32-
WARNING: on OSX, if you want to install into `CMAKE_INSTALL_PREFIX`, you have to specify it by disabling the `IN_PLACE_BUILD` cmake option which defaults to ON (see below).
33+
If compilation succeeds, on OSX this will produce a "shared library" file ending in `.scx`, and on Linux `.so`.
3334

3435
## Installing
3536

@@ -46,3 +47,9 @@ from within SuperCollider. Alternatively, you may install the plugin(s) system-w
4647
```
4748
Platform.systemExtensionDir
4849
```
50+
51+
## Development workflow
52+
53+
If you change your source file(s) or `CMakeLists.txt`, simply use `make` to recompile the shared library. You will need to restart scsynth/supernova for your changes to take effect.
54+
55+
If you change your `.sc` class file, you will need to restart sclang.

0 commit comments

Comments
 (0)