diff --git a/README.md b/README.md index 984543b..f26f60e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ It's designed to make it simple to send out an ASCII string of comma-separated v Instructions for the hardware-end of this hack are available here: [http://frontiernerds.com/brain-hack](http://frontiernerds.com/brain-hack) +This library pairs nicely with the Processing-based [BrainGrapher](https://github.com/kitschpatrol/BrainGrapher). + The `getCSV()` function returns a string (well, char*) listing the most recent brain data, in the following format: "signal strength, attention, meditation, delta, theta, low alpha, high alpha, low beta, high beta, low gamma, high gamma" @@ -21,7 +23,7 @@ The EEG power values — delta, theta, etc... - are a heavily filtered represent This project was formerly "Arduino-Brain-Library" on GitHub, but was renamed to just "Brain" in 2014 to play nicely with the Arduino IDE's new ""Sketch --> Import Library..." menu item. ###SOFTWARE SERIAL -Past versions of this library relied on a separate branch implementing support for NewSoftSerial. Improvements to both the bundled SoftwareSerial library and the underlying class hierarchy in Arduino 1.0 has allowed a single version of the Brain library to cover both use cases. Please **do not use** the old [softserial](https://github.com/kitschpatrol/Arduino-Brain-Library/tree/softserial) branch of this library! Please see +Past versions of this library relied on a separate branch implementing support for NewSoftSerial. Improvements to both the bundled SoftwareSerial library and the underlying class hierarchy in Arduino 1.0 has allowed a single version of the Brain library to cover both use cases. Please **do not use** the old [softserial](https://github.com/kitschpatrol/Brain/tree/softserial) branch of this library! Please see ###EXAMPLES @@ -33,12 +35,12 @@ Three examples are provided with the library: ###INSTALLATION There are two ways to install the library: -#####Manual Installation -[Download the repository's zip file](https://codeload.github.com/kitschpatrol/Brain/zip/master), decompress, rename it to Brain, and drag "Brain" folder to Arduino's "libraries" folder inside your sketch folder. (On the Mac, this is ~/Documents/Arduino/libraries by default. You may need to create this folder if it does not exist.) Restart the Arduino environment. #####Installation through the Arduino IDE -(TODO, need a proper release on GitHub to make this work well.) -Download the repository as a zip, and then in the Arduino IDE go to ""Sketch --> Import Library..." and find the Brain.zip file you just downloaded. +Download the [latest release](https://github.com/kitschpatrol/Brain/releases), and then in the Arduino IDE go to ""Sketch --> Import Library..." and point the file dialogue to the Brain.zip file you just downloaded. + +#####Manual Installation +Download the [latest release](https://github.com/kitschpatrol/Brain/releases), decompress, rename it to Brain, and drag "Brain" folder to Arduino's "libraries" folder inside your sketch folder. (On the Mac, this is ~/Documents/Arduino/libraries by default. You may need to create this folder if it does not exist.) Restart the Arduino environment. ###FUNCTION OVERVIEW