aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGuillaume Riou <guiloua2@hotmail.com>2014-05-13 14:39:05 -0400
committerGuillaume Riou <guiloua2@hotmail.com>2014-05-13 14:39:05 -0400
commit608179b3b15e2fe1a3e4d3cddac67eec22620880 (patch)
treec459231b7c5ced34055d55340e616cb7cc408c9a /README.md
parent768b41fb5433e556239e92eb0237a1c9720b7cde (diff)
parent466cc1b61c36c22411324a3c9dd5131642da193c (diff)
Merge branch 'master' of https://github.com/adelrune/Llammas
Conflicts: squelette_synth_midi.ino
Diffstat (limited to 'README.md')
-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.