tReadme updated - cynth - modular musical synthesizer using POSIX streams
(HTM) git clone git://src.adamsgaard.dk/cynth
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
(DIR) commit 7819acbf1f8888b4ffba4ecaef75d4a90ea05d10
(DIR) parent a4e55f71b09f1349db5c9148cea5d5cc0ab20138
(HTM) Author: Anders Damsgaard Christensen <adc@geo.au.dk>
Date: Thu, 16 Aug 2012 22:24:23 +0200
Readme updated
Diffstat:
M Makefile | 4 ++++
M README.rst | 23 ++++++++++++++++++++++-
2 files changed, 26 insertions(+), 1 deletion(-)
---
(DIR) diff --git a/Makefile b/Makefile
t@@ -16,3 +16,7 @@ test-osc: osc
@#./$< | aplay -c 1 -f S16_LE -r 44100
./$< -c 1 -r 44100 | aplay -c 1 -r 44100
@#./$< | aplay
+
+test: osc
+ cat seq-data/lead.txt | ./osc -w triangle -r 16000 | aplay -r 16000 &
+ cat seq-data/bass.txt | ./osc -r 16000 | aplay -r 16000
(DIR) diff --git a/README.rst b/README.rst
t@@ -1,4 +1,25 @@
-CYNTH - A modular software synthesizer after the POSIX philosophy
+``cynth`` - A modular software synthesizer after the POSIX philosophy
=================================================================
+Introduction
+------------
+``cynth`` is a modular synthesizer, where all instructions and data are sent through standard POSIX streams, making the sound synthesis and processing easy to customize, while allowing external input as well.
+
+Status and roadmap
+------------------
+- Oscillator with switchable waveforms: *Complete*
+- Modulating modules (echo, vibrato, clipping): *Not complete*
+- Scriptable sequencer which generates instructions for the oscillators in musical notation: *Not complete*
+
+Requirements
+------------
+- GCC
+- Alsa
+
+Example
+-------
+A simple melody consisting of a lead voice, played back with a triangle waveform, 16 upper harmonics, and a somewhat reduced volume. The lead is accompanied by a bass voice, using the standard sine wave. The sample rate is 16000 Hz:
+
+`cat seq-data/lead.txt | ./osc -w triangle -r 16000 -h16 -V 0.2 | aplay -r 16000 & cat seq-data/bass.txt | ./osc -r 16000 | aplay -r 16000`
+