aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Hurtubise <316k@legtux.org>2014-05-05 16:57:21 -0400
committerNicolas Hurtubise <316k@legtux.org>2014-05-05 16:57:21 -0400
commit5a1e6da2f8278c2b4a130ed3556a2aa3da7f953e (patch)
tree53409b8ccf6df10f7296f3a87af598dbade7b159
parent69666597a9a161325b3c2ab6b9d33bfa2df33c9d (diff)
Update the documentation
-rw-r--r--README.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md
index 419158c..8fac913 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,33 @@
Llammas
=======
-Llammas is Literally Another Monophonic Mozzi Arduino Synth
+*Llammas is Literally Another Monophonic Mozzi Arduino Synth*.
+This MIDI synthesizer has been developped with the [Mozzi library](https://sensorium.github.io/Mozzi/), a sound synthesis library for Arduino.
+
+## Features
+
+Llammas is a Monophonic synthesizer, with 3 oscillators (supporting different waveforms). It includes 2 LFO with flexible routing, 2 enveloppes (filter & amplitude). 3 operator FM synthesis and a multimode resonnant filter.
+
+### Supported filters
+
+- Lowpass
+- Highpass
+- Bendpass
+- Notch
+
+### Supported waveforms
+
+- Sine
+- Saw
+- Square
+
+### Supported FM Algorithms
+
+- Osc1 // Osc2 // Osc3
+- Osc1 // Osc2<-Osc3
+- Osc1<-Osc2<-Osc3
+- Osc1<-Osc2 // Osc1<-Osc3
+
+## Licence
+
+This synthesizer has been conceived by Guillaume Riou, Aude Forcione-Lambert & Nicolas Hurtubise and is distributed under the terms of the GNU General Public License v3. See the LICENSE file for more details.