README stuff

README.md

@@ -1,12 +1,12 @@
-# s a m p l e   b r a i n
+# Samplebrain
 
 A custom sample mashing app designed by Aphex Twin.
 
-Samplebrain chops samples up into a 'brain' of interconnected small
-sections called blocks which are connected into a network by
-similarity. It processes a target sample, chopping it up into blocks
-in the same way, and tries to match each block with one in it's brain
-to play in realtime.
+Samplebrain (made in 2015) chops samples up into a 'brain' of
+interconnected small sections called blocks which are connected into a
+network by similarity. It processes a target sample, chopping it up
+into blocks in the same way, and tries to match each block with one in
+it's brain to play in realtime.
 
 This allows you to interpret a sound with a different one. Over time
 developing it, we gradually added more and more tweakable parameters
@@ -20,24 +20,38 @@ Quick start:
 4. Click (re)generate target
 5. Press play
 
-# [Demo brain]()
+# [Demo brain session](https://static.thentrythis.org/samplebrain/demo.samplebrain)    
 # [Manual](docs/manual.md)
     
 # Binaries
 
-* [Windows]()
-* [Mac]()
-* Linux
-        
-# Installing/building
-     
-## Linux install:
+## Windows
 
-Install libraries for the sample engine:
+* [samplebrain_0.18_win.zip](http://static.thentrythis.org/samplebrain/https://static.thentrythis.org/samplebrain/samplebrain_0.18_win.zip)
+
+## Mac
+
+* [samplebrain_0.18_macintel.zip](https://static.thentrythis.org/samplebrain/samplebrain_0.18_macintel.zip)
+
+Contribution of a universal or apple silicon binary gratefully received (see building instructions below)
+
+## Linux
+    
+    $ sudo add-apt-repository ppa:thentrythis/samplebrain
+    $ sudo apt update
+    $ sudo apt install samplebrain
+
+If you'd like the right font, optionally:
+
+    $ sudo apt install ttf-mscorefonts-installer
+                
+# Building from source:
+
+Install libraries for the sample engine (use brew on mac, MinGW on win):
     
     $ sudo apt install libsndfile1-dev portaudio19-dev liblo-dev libfftw3-dev
 
-Install dependancies for the graphical user interface:
+Install dependancies for the interface:
         
     $ sudo apt install build-essential qtcreator qt5-default
 
@@ -46,7 +60,16 @@ Build $ run it:
     $ cd app
     $ qmake
     $ make
+    $ sudo make install
     $ samplebrain
+
+# Mac build additions:
+
+To make a mac app bundle:
+    
+* Run `macdeployqt` to copy all dependancies inside the app.
+* Copy desktop/samplebrain.icns (the icon) to the Resources directory in the bundle.
+* Edit Info.plist to add samplebrain.icns to CFBundleIconFile.
     
 ## What's here
 
@@ -56,12 +79,12 @@ Build $ run it:
     * code to build the Qt GUI app
 3. gui:
     * qt designer project files
+4. desktop:
+    * various icon file etc
 4. cooking:
     * sketches and ideas
     * proof of concept written in python
     * initial (abandoned) attempt at clojure version 
     
-# Todos:
 
-* Write VST version?