update readme

0x80 · Aug 7, 2016 · a3f0ebc · a3f0ebc
1 parent 391977e
commit a3f0ebc
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,10 @@ Shreditor Change Log
 1.0
 -------------------
 * Move firmware and banks check to device switch
-* Reimplement eeprom transfer, removing messed up threading approach
-* Major code cleanup
+* Reimplement eeprom transfer, removing threading mess
+* Major codebase cleanup
 * Remove RtMidi dependency
+* Bumped Max version to 7.2.4
 
 Beta 8
 -------------------

diff --git a/README.md b/README.md
@@ -1,10 +1,7 @@
 # Shreditor
 
-## TODO before release
-* put new builds on vauxlab, replace doc folder with a README.txt
-
 ## Description
-An editor for the [Shruthi-1](http://mutable-instruments.net/shruthi1) DIY synthesizer. A compact hybrid synth combining 8-bit oscillators with an analog filter.
+Shreditor is a software editor for the [Shruthi-1](http://mutable-instruments.net/shruthi1) DIY hardware synthesizer. An awesome little hybrid mono synth developed by Mutable Instruments, which combines 8-bit oscillators with various analog filter boards.
 
 ![screenshot](docs/images/shreditor-ui.png)
 
@@ -13,7 +10,7 @@ The editor application is built with [Max](https://cycling74.com/products/max),
 The patches and externals should work with both Max v6 and v7
 
 ## Features
-* Control all relevant parameters including matrix, sequencer and settings
+* Control all 100+ parameters including matrix, sequencer and settings
 * Bidirectional communication. Active update of patch and sequence data in the interface
 * Edit up to 8 devices simultaneously
 * Copy and paste patches and sequences between devices
@@ -30,12 +27,14 @@ There are also some things you can not do on a Shruthi without the Shreditor:
 ## Requirements
 Shruthi-1 with firmware >= v1.0. The firmware update instructions are found below.
 
+Additionally, if you want to build the Shreditor application from source you also need Max version 6 or higher.
+
 ## Usage
 The documentation on how to use the application can be found in __docs/user-manual.md__. Build instructions for OSX and Windows are listed below.
 
 ## Known Issues
 * Firmware version, for example 1.02, is wrongly reported as 1.00 in the interface.
-* Eeprom transfer progress is reporting double the bytes (nibbles).
+* Eeprom transfer progress is reporting nibbles as bytes (double the amount).
 
 ## Troubleshooting
 ### No compatible Shruthi firmware version was detected on this port.
@@ -50,18 +49,22 @@ The MIDI channel on which the Shruthi is listening can be found in the bottom ri
 Don't connect multiple Shruthi devices on the same physical MIDI port. The Shreditor uses sysex to communicate and because this is channel independent having more than one device on the same port will cause conflicts.
 
 ## Folder Structure
+```
 .
 ├── build : Prebuilt documentation and Shruthi-1 firmware
 ├── c74support : Max object SDK, as copied from Cycling '74
 ├── docs : User manual
 ├── notes : Some development related notes
 ├── objects : XCode & Visual Studio projects for building the vx.shruthi object
 └── shreditor : Max Shreditor project files
+```
 
 ## Prebuilt binaries
-The prebuilt Shreditor binaries can be found [here](. If you want to build it from source, read on.
+The prebuilt Shreditor binaries for OSX and Windows can be found [here](http://vauxlab.com/downloads/shreditor/). If you want to build it from source, read on.
+
+## Building the Shreditor from source
 
-## Build the Shreditor from source
+In order to build the application from source you will need to install [Max](https://cycling74.com/downloads/) on your system. For Windows you need the 32bit edition of Max.
 
 1) First build the vx.shruthi object using the project at `objects/Shreditor.xcodeproj` (XCode) or `objects/Shreditor.sln` (Visual Studio). Start the build process from the menu or cmd+b / F7. When successful this outputs the `vx.shruthi.mxo` (OSX) or `vx.shruthi.mxe` (Windows) binaries at `objects/bin`.
 
@@ -84,17 +87,16 @@ Addionally you can strip the app bundle of some unneccesary files to make it sma
 * resources/c74/externals/jitter
 * resources/c74/media
 
-
-## Update the device firmware
-The most up to date official firmware (v1.02) can be found in the `firmware` folder. To transfer the firmware, hold the rightmost switch on the device while powering on. Use a sysex tool like Elektron's C6 to transfer the firmware.
-
-In the C6 settings you'll have to set the "delay ticks" to something like 15, otherwise the transfer goes too fast and the last few leds on the Shruthi-1 won't get to blinking.
-
 ## Editing the Shreditor patch
 The patch (and all of its abstractions) opens in __presentation mode__. Hit __cmd + alt + e__ to switch to patching mode.
 
 In order to prevent window resizing by the user, the maximum window dimensions are limited to 980x830 to neatly contain just the UI and fit it on a 12" laptop screen. You can increase the maximum size by clicking on the message in the top right corner saying `window constrain 200 200 1500 1500, window exec` which sets the maximum dimensions to 1500x1500.
 
+## Device firmware
+The most up to date official firmware (v1.02) can be found in the `firmware` folder. To transfer the firmware, hold the rightmost switch on the device while powering on. Use a sysex tool like Elektron's C6 to transfer the firmware.
+
+In the C6 settings you'll have to set the "delay ticks" to something like 15, otherwise the transfer goes too fast and the last few leds on the Shruthi-1 won't get to blinking.
+
 ## Additional Development Notes
 Some additional notes regarding development can be found [here](/notes).
 
diff --git a/docs/images/shreditor-ui.png b/docs/images/shreditor-ui.png
diff --git a/docs/user-manual.md b/docs/user-manual.md
@@ -1,9 +1,9 @@
 Shreditor User Manual
 =================
 
-![screenshot](images/shreditor-ui.png =800x)
+![screenshot](images/shreditor-ui.png)
 
-1. Overview
+Overview
 ------------------
 
 ### Features
@@ -24,7 +24,7 @@ There are some things you can not do on a Shruthi without the Shreditor:
 ###Firmware
 Shreditor only supports firmware 1.0 and up.
 
-2. Setting Up
+Setting Up
 ------------------
 These are the steps to get you up and running quickly. You typically only have to go through these steps once.
 
@@ -41,7 +41,7 @@ In the *Devices* tab enter a label for your Shruthi, for example "4 Pole Mission
 
 Now you are ready to store the device settings in one of the 8 available slots. At first all of the slots will appear white, indicating that they are empty. Store the preset in one of the slots by hitting [shift-click]. The slot color will change to dark grey (meaning it is filled) and then blue (which means it is active). Up to 8 different devices can be configured this way.
 
-###Step 4: Download the Patches
+###Step 4: Download the data from the device
 In order to minimize transfer of data and to keep the UI responsive, the Shreditor keeps a copy of the device internal eeprom storage at all time. This way, when you load a patch, the editor knows all of the settings instantly and you can navigate without having to request the data from the device.
 
 You can request the data from the Shruthi by going to the *Data* tab and click on the [request] button. You will see a progress bar indicating the status of the data transfer.
@@ -52,7 +52,7 @@ After the transfer has completed you should see all of your patches show up in t
 If you own more than one Shruthi, and you have enough physical midi ports, you can repeat steps 2-4 for each device. The Shreditor will let you edit these devices simultaneously. You can switch back and forth and it will keep track of your edits. Please note that you *can not* connect multiple devices to the same midi port, since the editor communicates with sysex and sysex messages are not tied to any midi channel.
 
 
-3. Caveats
+Caveats
 ------------
 Listed here are some things worth knowing when using the Shreditor, because they might function differently from what you would expect.