aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Runge <dave@sleepmap.de>2015-03-30 18:54:19 +0200
committerDavid Runge <dave@sleepmap.de>2015-03-30 18:54:19 +0200
commit5fd9619508acfd486fa55b99fff4090b88fc6261 (patch)
tree47ac2d68da0f8f873ddb71b4f56bef6793cf7746
parent4b9083d2570f42346782bc976a55102ceaa4479a (diff)
downloadthesoundofpeople-5fd9619508acfd486fa55b99fff4090b88fc6261.tar.gz
thesoundofpeople-5fd9619508acfd486fa55b99fff4090b88fc6261.tar.bz2
thesoundofpeople-5fd9619508acfd486fa55b99fff4090b88fc6261.tar.xz
thesoundofpeople-5fd9619508acfd486fa55b99fff4090b88fc6261.zip
README.md: Adding screenshot, adding GUI information and TODO. Fixing emphasis.
-rw-r--r--README.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/README.md b/README.md
index e39025c..d537f84 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,21 @@
# thesoundofpeople
## About
-Supercollider classes for interacting with data sets from http://opensnp.org (parsing, sonification, etc.).
-This is a prototype! It's quite slow and eats a lot of RAM. I've only tested it on Linux with JACK. So be aware of that, when using it!
+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!*
## Features
-- Parse 23andme files, write them to a different - self-invented and faster readable - 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**)!
+- 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
+- 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
+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)
## Installation
@@ -17,7 +24,7 @@ Clone this repository to somewhere sclang will pick it up on recompiling its cla
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).
+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!
cd ~/some/other/directory
@@ -25,8 +32,12 @@ Symlinking is fine, too!
cd ./local/share/SuperCollider/Extensios/local/
ln -s ~/some/other/directory/thesoundofpeople .
+## Usage
+Go to the cloned directory and open **thesoundofpeople.scd** in your favorite SuperCollider IDE.
+All further steps are explained there.
+
## TODO
-- flesh out SNP.sc (a million instances eat too much RAM on filling a SNPDict), that comes with a lot of looking around what has to be changed in the other classes to make this work.
+- GUI buttons for start/pause/stop, file chooser for the file to parse/read, option for choosing/reloading the speaker setup
- 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)