Skip to content

Commit 9fea495

Browse files
committed
Readme updates in preparation for 1.0 release.
1 parent aee6ff1 commit 9fea495

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ It's designed to make it simple to send out an ASCII string of comma-separated v
88

99
Instructions for the hardware-end of this hack are available here: [http://frontiernerds.com/brain-hack](http://frontiernerds.com/brain-hack)
1010

11+
This library pairs nicely with the Processing-based [BrainGrapher](https://github.com/kitschpatrol/BrainGrapher).
12+
1113
The `getCSV()` function returns a string (well, char*) listing the most recent brain data, in the following format:
1214
"signal strength, attention, meditation, delta, theta, low alpha, high alpha, low beta, high beta, low gamma, high gamma"
1315

@@ -21,7 +23,7 @@ The EEG power values — delta, theta, etc... - are a heavily filtered represent
2123
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.
2224

2325
###SOFTWARE SERIAL
24-
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
26+
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
2527

2628

2729
###EXAMPLES
@@ -33,12 +35,12 @@ Three examples are provided with the library:
3335

3436
###INSTALLATION
3537
There are two ways to install the library:
36-
#####Manual Installation
37-
[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.
3838

3939
#####Installation through the Arduino IDE
40-
(TODO, need a proper release on GitHub to make this work well.)
41-
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.
40+
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.
41+
42+
#####Manual Installation
43+
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.
4244

4345

4446
###FUNCTION OVERVIEW

0 commit comments

Comments
 (0)