tClean up README - 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 1928fa5aedeeb0b35c47989265a8a959445e6d2a
(DIR) parent 61b0ceefe94663649b986fe7b31b54a54cd5bbed
(HTM) Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Sat, 7 Sep 2019 06:57:09 +0200
Clean up README
Diffstat:
M README.rst | 33 +++++++++++++++++++------------
1 file changed, 20 insertions(+), 13 deletions(-)
---
(DIR) diff --git a/README.rst b/README.rst
t@@ -1,28 +1,35 @@
-``cynth`` - A modular software synthesizer after the POSIX philosophy
-=================================================================
+``cynth`` - A modular software synthesizer
+==========================================
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.
+``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*
+- Scriptable sequencer which generates instructions for the oscillators
+ in musical notation: *Not complete*
Requirements
------------
-- GCC
+- C compiler
- 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`
-
-The above example is also available through the command `make test` in the root directory.
-
+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
+
+The above example is also available through the command `make test`
+in the root directory.