Skip to content

Commit e908c2b

Browse files
author
Nathan Ho
authored
README: this repository demonstrates
1 parent d1ddf14 commit e908c2b

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
This repository a series of examples demonstrating how to write UGens for [SuperCollider](https://github.com/supercollider/supercollider) (not to be confused with quarks, which are libraries for the language). The [Writing Unit Generators](http://doc.sccode.org/Guides/WritingUGens.html) helpfile is a comprehensive tutorial. Chapter 25 of [the SuperCollider Book](http://www.supercolliderbook.net/) is also a useful resource, although the build instructions are outdated.
1+
# SuperCollider Example Plugins
2+
3+
This repository demonstrates how to write UGens for [SuperCollider](https://github.com/supercollider/supercollider) using a series of examples. Custom UGens are packaged in server plugins. Plugins are not to be confused with quarks, which are libraries for the language.
4+
5+
This supplements the [Writing Unit Generators](http://doc.sccode.org/Guides/WritingUGens.html) helpfile. Chapter 25 of [the SuperCollider Book](http://www.supercolliderbook.net/) is also a useful resource, although the build instructions are outdated.
26

37
There is a lot of conflicting material out there for UGen building. This is the official repository and should be the most up to date.
48

@@ -13,7 +17,7 @@ Beyond this repository, the reader is encouraged to look at [sc3-plugins](https:
1317

1418
## Compiling
1519

16-
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.**
20+
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...**
1721

1822
CMake dumps a lot of files into your working directory, so you should always start by creating the `build/` directory:
1923

@@ -35,7 +39,7 @@ The path should contain a file at `include/plugin_interface/SC_PlugIn.h`. If you
3539
CMake will remember your `SC_PATH`, so you only need to run that once. After that, simply build using `make`:
3640

3741
```shell
38-
example-plugins/01-BoringMixer/build/$ make
42+
example-plugins/01a-BoringMixer/build/$ make
3943
```
4044

4145
This will produce a "shared library" file ending in `.scx`. On Linux, the extension is `.so`.

0 commit comments

Comments
 (0)