From 5f6bb41a2987991c1698d64835c944267f4da839 Mon Sep 17 00:00:00 2001 From: David Runge Date: Fri, 5 May 2017 11:44:29 +0200 Subject: README.rst: Mentioning midi conversion capabilities. Adding information on SynthDefs in Features. Fixing a lot of missing line breaks. --- README.rst | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 1a72308..7fa17e4 100644 --- a/README.rst +++ b/README.rst @@ -11,24 +11,32 @@ Supported devices Features -------- -* convenience methods to convert between frequency, amplitude and corresponding output voltage +* convenience methods to convert between midi, frequency, amplitude and + corresponding output voltage +* **ZZZConstant**: a *SynthDef* for constant pitch (use helper functions to + convert your input to amplitude - the *\mul* parameter) +* **ZZZClock**: a *SynthDef* for clock signals. Responds to Frequencies Installation ------------ -The classes are an extension of the |supercollider| language, therefore their installation corresponds to |quark_installation|. +The classes are an extension of the |supercollider| language, therefore their +installation corresponds to |quark_installation|. Usage ----- -To create a new object interfacing your |es-3|, instantiate the *ZZZES3* class with an Array holding your eight ADAT output channels: +To create a new object interfacing your |es-3|, instantiate the *ZZZES3* class +with an Array holding your eight ADAT output channels: .. code:: supercollider // RME Babyface example ~es3 = ZZZES3(Array.series(8, 4, 1)); -To play a Synth on one of the eight |es-3| outputs you can use one of the *SynthDefs* added by the *ZZZ* class, such as *\ZZZConstant* (for constant notes) or *\ZZZClock* (for clock): +To play a Synth on one of the eight |es-3| outputs you can use one of the +*SynthDefs* added by the *ZZZ* class, such as *\ZZZConstant* (for constant +notes) or *\ZZZClock* (for clock): .. code:: supercollider @@ -42,7 +50,9 @@ To play a Synth on one of the eight |es-3| outputs you can use one of the *Synth .. note:: - | The convenience function *ZZZES3.out* accepts integers from 1 to 8 (corresponding to the numbering on the device itself) and returns the *Out* number connected to it. + | The convenience function *ZZZES3.out* accepts integers from 1 to 8 + (corresponding to the numbering on the device itself) and returns the *Out* + number connected to it. | Generally, in |supercollider| channel numbering starts from 0, though! @@ -62,11 +72,17 @@ Just like with any other *Synth*, you can now change their settings: Background ---------- | Modular synthesizers are controllable through several ranges of voltage. +| |cv_gate| as defined by |doepfer| in the |a100_manual| might not be coherently + used throughout all Eurorack modules however. | -| |cv_gate| as defined by |doepfer| in the |a100_manual| might not be coherently used throughout all Eurorack modules however. -| The *ZZZ* classes nonetheless try to adhere to the standard, while at the same time provide convenience functions to low-level conversion. -| By default the helper functions are able to convert frequencies in the |c_musical_note| (between *C-2* and *C10*) to an output between -5V and 7V (adhering to the 1V/octave scheme). -| As the range is not fixed, but can be moved up and down (e.g. when using filters or oscillators), you might have to make some adjustments to your module, to get "in tune". +| The *ZZZ* classes nonetheless try to adhere to the standard, while at the + same time provide convenience functions to low-level conversion. +| By default the helper functions are able to convert frequencies in the + |c_musical_note| (between *C-2* and *C10*) to an output between -5V and 7V + (adhering to the 1V/octave scheme) - the MIDI note range being a subset of it. +| As the range is not fixed, but can be moved up and down (e.g. when using + filters or oscillators), you might have to make some adjustments to your + module, to get "in tune". .. |supercollider| raw:: html -- cgit v1.2.3-54-g00ecf