Skip to content

Commit 2a94af8

Browse files
update readme
1 parent 4d746e8 commit 2a94af8

File tree

3 files changed

+8
-30
lines changed

3 files changed

+8
-30
lines changed

Firmata.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#define FIRMATA_MINOR_VERSION 6 // for backwards compatible changes
2424
#define FIRMATA_BUGFIX_VERSION 0 // for bugfix releases
2525

26-
#define MAX_DATA_BYTES 64 // max number of data bytes in incoming messages
26+
#define MAX_DATA_BYTES 64 // max number of data bytes in incoming messages
2727

2828
// message command bytes (128-255/0x80-0xFF)
2929
#define DIGITAL_MESSAGE 0x90 // send data for a digital pin

readme.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Most of the time you will be interacting with arduino with a client library on t
5050
Note: The above libraries may support various versions of the Firmata protocol and therefore may not support all features of the latest Firmata spec nor all arduino and arduino-compatible boards. Refer to the respective projects for details.
5151

5252
##Updating Firmata in the Arduino IDE
53-
The version of firmata in the Arduino IDE contains an outdated version of Firmata. To update Firmata, clone the repo into the location of firmata in the arduino IDE or download the latest [tagged version](https://github.com/firmata/arduino/tags) (stable), rename the folder to "Firmata" and replace the existing Firmata folder in your Ardino application. If you are using Arduino 1.5.x, you'll need to delete the avr specific Firmata folder per the instructions in the next section.
53+
The version of firmata in the Arduino IDE contains an outdated version of Firmata. To update Firmata, clone the repo into the location of firmata in the arduino IDE or download the latest [tagged version](https://github.com/firmata/arduino/tags) (stable), rename the folder to "Firmata" and replace the existing Firmata folder in your Ardino application.
5454

5555
**Mac OSX**:
5656

@@ -67,8 +67,8 @@ Using the Git Shell application installed with [GitHub for Windows](http://windo
6767

6868
update the path and arduino version as necessary
6969
```bash
70-
$ rm -r c:/Program\ Files/arduino-1.x/libraries/Firmata
71-
$ git clone [email protected]:firmata/arduino.git c:/Program\ Files/arduino-1.x/libraries/Firmata
70+
$ rm -r c:/Program\ Files/arduino/libraries/Firmata
71+
$ git clone [email protected]:firmata/arduino.git c:/Program\ Files/arduino/libraries/Firmata
7272
```
7373

7474
Note: If you use GitHub for Windows, you must clone the firmata/arduino repository using the Git Shell application as described above. You can use the Github for Windows GUI only after you have cloned the repository. Drag the Firmata file into the Github for Windows GUI to track it.
@@ -77,38 +77,16 @@ Note: If you use GitHub for Windows, you must clone the firmata/arduino reposito
7777

7878
update the path and arduino version as necessary
7979
```bash
80-
$ rm -r ~/arduino-1.x/libraries/Firmata
81-
$ git clone [email protected]:firmata/arduino.git ~/arduino-1.x/libraries/Firmata
82-
```
83-
84-
##Updating Firmata in the Arduino 1.5.0, 1.5.1 or 1.5.2 IDE
85-
Follow the instructions above to copy Firmata to the libraries directory. However
86-
you will also need to delete the version of Firmata that is included in the avr
87-
platform specific libraries directory. You'll find it in the following locations
88-
depending on your OS. Delete the Firmata folder. Beginning with Arduino 1.5.3 this
89-
step will no longer be necessary.
90-
91-
**Mac OSX**:
92-
```
93-
/Applications/Arduino.app/Contents/Resources/Java/hardware/arduino/avr/libraries/Firmata
94-
```
95-
96-
**Windows**:
97-
```
98-
/Program\ Files/arduino-1.5.x/hardware/arduino/avr/libraries/Firmata
99-
```
100-
101-
**Linux**
102-
```
103-
~/arduino-1.5.x/hardware/arduino/avr/libraries/Firmata
80+
$ rm -r ~/arduino/libraries/Firmata
81+
$ git clone [email protected]:firmata/arduino.git ~/arduino/libraries/Firmata
10482
```
10583

10684
<a name="contributing" />
10785
##Contributing
10886

10987
If you discover a bug or would like to propose a new feature, please open a new [issue](https://github.com/firmata/arduino/issues?sort=created&state=open). Due to the limited memory of standard Arduino boards we cannot add every requested feature to StandardFirmata. Requests to add new features to StandardFirmata will be evaluated by the Firmata developers. However it is still possible to add new features to other Firmata implementations (Firmata is a protocol whereas StandardFirmata is just one of many possible implementations).
11088

111-
To contribute, fork this respository and create a new topic branch for the bug, feature or other existing issue you are addressing. Submit the pull request against the *dev* branch.
89+
To contribute, fork this respository and create a new topic branch for the bug, feature or other existing issue you are addressing. Submit the pull request against the *dev* branch. If you are contributing a feature for configurable firmata, submit the pull request against the *configurable_dev* branch.
11290

11391
If you would like to contribute but don't have a specific bugfix or new feature to contribute, you can take on an existing issue, see issues labeled "pull-request-encouraged". Add a comment to the issue to express your intent to begin work and/or to get any additional information about the issue.
11492

release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ zip -r Firmata.zip ./Firmata/
1919
cd ..
2020
mv ./temp/Firmata.zip Firmata-2.6.0.zip
2121

22-
#package for Arduino 1.5.x
22+
# package for Arduino 1.5.x
2323
cp library.properties temp/Firmata
2424
cd temp/Firmata
2525
mv readme.md ./extras/

0 commit comments

Comments
 (0)