aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Runge <dave@sleepmap.de>2016-04-23 14:32:42 +0200
committerDavid Runge <dave@sleepmap.de>2016-04-23 14:32:42 +0200
commit33d8b5bff1feb3c35fc049e29fcaca985d50520b (patch)
tree0cab28e84a6429d59a546d542eb73d69daaef155 /README.rst
parentbc41765159c52b10842a595b6785d170dfc72470 (diff)
downloadbowelyzer-33d8b5bff1feb3c35fc049e29fcaca985d50520b.tar.gz
bowelyzer-33d8b5bff1feb3c35fc049e29fcaca985d50520b.tar.bz2
bowelyzer-33d8b5bff1feb3c35fc049e29fcaca985d50520b.tar.xz
bowelyzer-33d8b5bff1feb3c35fc049e29fcaca985d50520b.zip
README.rst: Adding first version of a README.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..9c535bf
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,37 @@
+bowelyzer
+#########
+
+| |supercollider| classes for analysis of several audio streams and sending of OSC messages based on amplitude thresholds and frequency maxima
+
+Features
+________
+
+Installation
+____________
+Clone this repository to somewhere sclang will pick it up on recompiling its class library:
+
+ .. code:: bash
+
+ cd ~/.local/share/SuperCollider/Extensions/local
+ git clone git://sleepmap.de/audio/bowelyzer.git
+
+If the local folder doesn't exist, create it, otherwise you can also directly clone into the Extensions folder (the folder and all of its children will get picked up on recompile).
+Symlinking is fine, too!
+
+ .. code:: bash
+
+ cd ~/some/other/directory
+ git clone git://sleepmap.de/audio/bowelyzer.git
+ cd ./local/share/SuperCollider/Extensios/local/
+ ln -s ~/some/other/directory/bowelyzer .
+
+Usage
+_____
+Go to the cloned directory and open **bowelyzer.scd** in your favorite SuperCollider IDE.
+All further steps are explained there.
+
+
+.. |supercollider| raw:: html
+
+ <a href="https://supercollider.github.io/" target="_blank">SuperCollider</a>
+