Commits

Fabian Affolter  committed 858ea4b

Small updates

  • Participants
  • Parent commits f27c99d

Comments (0)

Files changed (1)

--*- restructuredtext -*-
+.. -*- mode: rst -*-
+
+.. _Firmata: http://firmata.org/
+.. _Arduino http://arduino.cc/
+.. _pySerial http://pyserial.sourceforge.net/
+.. _pyFirmata https://bitbucket.org/tino/pyfirmata/
+.. _Source https://bitbucket.org/tino/pyfirmata/get/0.9.4.tar.gz
 
 =========
 pyFirmata
 =========
 
+pyFirmata_ is a Python interface for the Firmata_ protocol. It is compliant
+with Firmata 2.1.
+
+Prerequirement
+==============
+
+Arduino
+-------
+The Firmata firmware is included in Arduino_ 0012 or later. Use File -> 
+Examples > Firmata > StandardFirmata to get the sketch with the standard
+firmware and upload it to your Arduino.
+
+Other devices
+-------------
+Make the Firmata firmaware available on your device. Please refer to the 
+documentation of this device to archive this.
+
+Installation
+============
+
+pyFirmata depends on pySerial_ . Please install pySerial first.
+
+Dowload the Source_ and upack it.
+
+    $ wget https://bitbucket.org/tino/pyfirmata/get/0.9.4.tar.gz \
+        -O pyfirmata-0.9.4.tar.gz
+    $ tar -xzf pyfirmata-0.9.4.tar.gz && mv tino-pyfirmata-599e57b5f400 \
+        pyfirmata-0.9.4
+    $ cd pyfirmata-0.9.4
+    $ su python setup.py install
+
+Or if you like to use the latest source.
+
+    $ hg clone ssh://hg@bitbucket.org/tino/pyfirmata
+    $ cd pyfirmata
+    $ su python setup.py install
+
 Usage
 =====
 
 Examples
 ========
 
-The ``examples/`` folder contains a few examples script for the usage of 
+The ``examples/`` folder contains a few example scripts for the usage of 
 pyfirmata. Please follow the comments in the files for the setup.
     
 Board layout