aboutsummaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorTat-Chee Wan (USM)2011-06-03 15:34:22 +0800
committerNicolas Schodet2012-02-08 22:21:04 +0100
commit0cb7812c2b8b42df9b48f1d8537b16386ac1db92 (patch)
tree8a703cbf2229155201f47f48863cb8ecb56c41f9 /README
parent5aade3e1f58f8ea527f75682b56692383c864c77 (diff)
added setup information for package release
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..cf67c91
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+Introduction
+============
+Pyfantom is a Python wrapper for the LEGO Mindstorms Fantom Driver.
+The Fantom Driver is available for Mac OSX and Windows, from:
+
+ http://mindstorms.lego.com/en-us/support/files/default.aspx
+
+Pyfantom exposes the routines for interfacing to the LEGO Mindstorms NXT
+using python applications.
+
+The Fantom API is documented in the Fantom SDK 1.0.x available from the same
+site as the LEGO Fantom Drivers.
+
+Requirements (Mac OSX)
+======================
+
+ * Python 2.6.x (Mac OSX default), or Python 2.7 Universal Build (MacPorts)
+ * LEGO Mindstorms Fantom Drivers
+
+Requirements (Windows)
+======================
+[TBD, not tested yet]
+ * Python >= 2.6
+ * LEGO Mindstorms Fantom Drivers
+
+Installation
+============
+
+If you're installing using the source package, first extract the source package, then:
+
+# python setup.py install
+
+inside the package directory. This should be run as root (or use sudo)