aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Runge <dave@sleepmap.de>2021-01-04 13:00:07 +0100
committerDavid Runge <dave@sleepmap.de>2021-01-04 13:00:07 +0100
commit69e6ae13be088b8af1fd99f29686f2871b2e1919 (patch)
tree8beb6d6a1eb8ddfa4900feca11cf10d0bd59f871 /README.rst
parenta8d3922ab5977a0b9a16d817db37d8642d8d0a10 (diff)
downloadzzz-69e6ae13be088b8af1fd99f29686f2871b2e1919.tar.gz
zzz-69e6ae13be088b8af1fd99f29686f2871b2e1919.tar.bz2
zzz-69e6ae13be088b8af1fd99f29686f2871b2e1919.tar.xz
zzz-69e6ae13be088b8af1fd99f29686f2871b2e1919.zip
Switch to simple links
README.rst: Code hosters such as gitlab are not able to render raw::html blocks.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst67
1 files changed, 19 insertions, 48 deletions
diff --git a/README.rst b/README.rst
index 992941a..72d2cc3 100644
--- a/README.rst
+++ b/README.rst
@@ -1,13 +1,14 @@
ZZZ
###
-| |SuperCollider| classes to interface with |expert_sleepers| devices.
+`SuperCollider <https://supercollider.github.io/>`_ classes to interface with
+`Expert Sleepers <https://www.expert-sleepers.co.uk/>`_ devices.
Supported devices
-----------------
-* |es-3|
-* |es-8|
+* `ES-3 <https://www.expert-sleepers.co.uk/es3.html>`_
+* `ES-8 <https://www.expert-sleepers.co.uk/es8.html>`_
Features
--------
@@ -23,8 +24,11 @@ Features
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
+<https://supercollider.github.io/>`_ language (`sclang
+<http://doc.sccode.org/>`_), therefore their installation corresponds to `how
+Quarks are installed
+<https://github.com/supercollider-quarks/quarks#installing-a-quark>`_.
Usage
-----
@@ -44,7 +48,7 @@ channels connected to the module and the server instance in use:
| The instantiation of *ZZZDevice* conveniently makes the outputs of the
device available in a numbering range from 1-8 (as displayed on the
hardware).
- | Generally, in |supercollider| channel numbering starts with 0, though!
+ | Generally, in SuperCollider channel numbering starts with 0, though!
To interface with your module on one of the eight outputs, you can make use of
the *SynthDefs* added by the *ZZZ* class:
@@ -75,14 +79,17 @@ Background
----------
| Modular synthesizers are controllable through several ranges of voltage.
-| However, |cv_gate| as defined by |doepfer| in the |a100_manual| might not be coherently
- used throughout all Eurorack modules.
-|
+| However, `CV/ Gate <https://en.wikipedia.org/wiki/CV/gate>` as defined by
+ `Doepfer <http://www.doepfer.de>`_ in the `A100 manual
+ <http://www.doepfer.de/a100_man/a100t_e.htm>`_ might not be used coherently
+ throughout all Eurorack modules.
+
| The *ZZZ* classes nonetheless try to adhere to the standard, while at the
same time providing 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.
+| By default the helper functions are able to convert frequencies in the `range
+ of twelve octaves <https://en.wikipedia.org/wiki/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".
@@ -91,39 +98,3 @@ License
-------
This code is licensed under the terms of the GPL-3.0-or-later.
-
-.. |supercollider| raw:: html
-
- <a href="https://supercollider.github.io/" target="_blank">SuperCollider</a>
-
-.. |expert_sleepers| raw:: html
-
- <a href="http://www.expert-sleepers.co.uk/" target="_blank">Expert Sleepers</a>
-
-.. |es-3| raw:: html
-
- <a href="http://www.expert-sleepers.co.uk/es3.html" target="_blank">ES-3</a>
-
-.. |es-8| raw:: html
-
- <a href="http://www.expert-sleepers.co.uk/es8.html" target="_blank">ES-8</a>
-
-.. |quark_installation| raw:: html
-
- <a href="https://github.com/supercollider-quarks/quarks#installing-a-quark" target="_blank">the way quarks are installed</a>
-
-.. |cv_gate| raw:: html
-
- <a href="https://en.wikipedia.org/wiki/CV/gate" target="_blank">CV/Gate</a>
-
-.. |doepfer| raw:: html
-
- <a href="http://www.doepfer.de" target="_blank">Doepfer</a>
-
-.. |a100_manual| raw:: html
-
- <a href="http://www.doepfer.de/a100_man/a100t_e.htm" target="_blank">A100 manual</a>
-
-.. |c_musical_note| raw:: html
-
- <a href="https://en.wikipedia.org/wiki/C_(musical_note)" target="_blank">range of 12 octaves</a>