diff options
| -rw-r--r-- | Makefile.sccompile | 2 | ||||
| -rw-r--r-- | README.md | 22 |
2 files changed, 23 insertions, 1 deletions
diff --git a/Makefile.sccompile b/Makefile.sccompile index 9357afb..521fa15 100644 --- a/Makefile.sccompile +++ b/Makefile.sccompile @@ -3,7 +3,7 @@ BUILD_DIR ?= ./build CXXFLAGS := $(CXXFLAGS) LFLAGS := -fPIC -shared $(LFLAGS) -scbuilddir := $(BUILD_DIR)/Supercollider +scbuilddir := $(BUILD_DIR)/SuperCollider extdir := $(scbuilddir)/Extensions dspsrc := $(wildcard *.dsp) diff --git a/README.md b/README.md new file mode 100644 index 0000000..83af6c7 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Loquelic Iteritas Clone +An implementation of the [Loquelic Iteritas](https://static1.squarespace.com/static/58c709192e69cf2422026fa6/t/5c898cd5e2c48366a4eef8ab/1552518368472/LI_manual.pdf) +Eurorack oscillator module using the [Faust](https://faust.grame.fr/) programming language. +## Requirements +Install the Faust compiler and libfaust [here](https://faust.grame.fr/downloads/) (or through your distro's package manager). +You can also simply upload the .dsp files to the Faust [online IDE](https://faustide.grame.fr/), which is capable of compiling +binaries for a variety of platforms. +## Build SuperCollider Plugin +This repository currently only provides a script to build the module as a SuperCollider plugin. + +``` sh +make supercollider +``` +To install it, move the contents of `build/Supercollider/Extensions` to your SuperCollider extensions directory, +which is typically found at `~/.local/share/SuperCollider/Extensions` on Linux (and somewhere under `~/Library/Application Support` on mac +if I recall correctly). +Note that the file paths in this Makefile are currently hard-coded based on the directory structure used by the Arch Linux repo package. +If it fails to find the correct headers or architecture files you will probably need to adjust these paths based on your own system. +## Build other plugin types +VST/LV2 plugins, standalone binaries, etc. can be built using the various `faust2[...]` scripts which are typically packaged with Faust. +More information is available in the Faust [documentation](https://faustdoc.grame.fr/manual/tools/). + |