aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Runge <dave@sleepmap.de>2016-04-23 14:01:42 +0200
committerDavid Runge <dave@sleepmap.de>2016-04-23 14:01:42 +0200
commit58ff328e48073aa919e1d74354bfe6deeb8f7072 (patch)
tree0fd294c181966e21be50fcc9e70bc908b1c01933
parent1aacf852fa04ec92fb4cac11b74a82ae2f9e4cda (diff)
downloadthesoundofpeople-58ff328e48073aa919e1d74354bfe6deeb8f7072.tar.gz
thesoundofpeople-58ff328e48073aa919e1d74354bfe6deeb8f7072.tar.bz2
thesoundofpeople-58ff328e48073aa919e1d74354bfe6deeb8f7072.tar.xz
thesoundofpeople-58ff328e48073aa919e1d74354bfe6deeb8f7072.zip
README.rst: Moving README to restructuredtext, updating, removing TODO.
-rw-r--r--README.rst (renamed from README.md)60
1 files changed, 40 insertions, 20 deletions
diff --git a/README.md b/README.rst
index d6be4de..8ea0809 100644
--- a/README.md
+++ b/README.rst
@@ -1,47 +1,67 @@
-# thesoundofpeople
+thesoundofpeople
+################
-## About
-Supercollider classes for interacting with data sets from [OpenSNP](https://opensnp.org) (parsing, retrieving metadata, rendering audio from, etc.).
-**Note:** *This is a prototype! It is developed on Linux using JACK, therefore the following features have only been tested there!*
+||supercollider classes for interacting with data sets from |opensnp| (parsing, retrieving metadata, rendering audio from, etc.).
-## Features
-- Parse 23andme files, write them to a different - optimized for the work with *The Sound Of People* - format.
-- Loading the contents of both types of files (parsed and read) into a SuperCollider Dictionary. This will require **a lot** of RAM. Get ready for ~5,7GB (*parsing*) and ~4,7GB (*reading*).
-The amount will increase during playback - you will most likely end up using ~6,0GB!
+ **Note:** *This is a prototype! It is developed on Linux using JACK, therefore the following features have only been tested there!*
+
+Features
+________
+- Parse 23andme files, write them to a different - optimized for the work with **The Sound Of People** - format.
+- Loading the contents of both types of files (parsed and read) into a SuperCollider Dictionary. This will require **a lot** of RAM. Get ready for ~5,7GB (*parsing*) and ~4,7GB (*reading*). The amount will increase during playback - you will most likely end up using ~6,0GB!
- Retrieve metadata (at the moment only resolvers for SNPs) for SNPs and the data sets
- Rendering sound from positions (or rather: bases/base pairs at a position on a chromosome) of up to 25 chromosomes at the same time.
- Possible audio setups are: **2**, **4**, **6**, **8** and **12** speakers
- A GUI showing the current speaker setup and currently playing SNP on chromosomes
-## GUI
+GUI
+___
The GUI is still pretty minimalistic and currently just - non-interactively - showing which SNP is playing on which chromsome (and thus also on which speaker).
-![GUI](https://git.sleepmap.de/thesoundofpeople.git/plain/thesoundofpeople-gui.png)
-## Audio
-For audio samples (only stereo - and please bear in mind that the main focus has been multi-channel use for this application!) visit [Soundcloud](https://soundcloud.com/thesoundofpeople).
+.. figure:: https://git.sleepmap.de/thesoundofpeople.git/plain/thesoundofpeople-gui.png
+ :alt: The Sound Of People GUI
+
+ The Sound Of People GUI
-## Installation
+Audio
+_____
+| For audio samples (only stereo - and please bear in mind that the main focus has been multi-channel use for this application!) visit |soundcloud|
+Installation
+____________
Clone this repository to somewhere sclang will pick it up on recompiling its class library:
+ .. code:: bash
+
cd ~/.local/share/SuperCollider/Extensions/local
git clone git://sleepmap.de/thesoundofpeople.git
If the local folder doesn't exist, create it, otherwise you can also directly clone into the Extensions folder (the folder and all of its children will get picked up on recompile).
Symlinking is fine, too!
+ .. code:: bash
+
cd ~/some/other/directory
git clone git://sleepmap.de/thesoundofpeople.git
cd ./local/share/SuperCollider/Extensios/local/
ln -s ~/some/other/directory/thesoundofpeople .
-## Usage
+Usage
+_____
Go to the cloned directory and open **thesoundofpeople.scd** in your favorite SuperCollider IDE.
All further steps are explained there.
-## TODO
-- GUI buttons for start/pause/stop, file chooser for the file to parse/read, option for choosing/reloading the speaker setup
-- Add .schelp files
-- fine grain the synthesizers used, so each chromosome will become more distinct (currently only X, Y and MT are very recognizable)
-- use a set of filters based upon the form of each chromosome and its "interesting areas"
-- make updating resolvers less RAM consuming (and thus usable)
+
+.. |supercollider| raw:: html
+
+ <a href="https://supercollider.github.io/" target="_blank">SuperCollider</a>
+
+.. |opensnp| raw:: html
+
+ <a href="https://opensnp.org" target="_blank">SuperCollider</a>
+
+.. |soundcloud| raw:: html
+
+ <a href="https://soundcloud.com/thesoundofpeople" target="_blank">Soundcloud</a>
+
+