summaryrefslogtreecommitdiff
path: root/index.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'index.mdwn')
-rw-r--r--index.mdwn59
1 files changed, 59 insertions, 0 deletions
diff --git a/index.mdwn b/index.mdwn
new file mode 100644
index 0000000..0d533d4
--- /dev/null
+++ b/index.mdwn
@@ -0,0 +1,59 @@
+# Introduction
+
+Pyfantom is a Python wrapper for the LEGO Mindstorms Fantom Driver. The Fantom
+Driver is available for Mac OSX and Windows, from [LEGO website][].
+
+ [LEGO website]: 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
+
+# Get sources
+
+You can clone the git repository with:
+
+ git clone http://git.ni.fr.eu.org/pyfantom.git/
+
+Alternatively, you can download a [snapshot][] and extract it on your
+computer.
+
+You can also browse source online using [gitweb][].
+
+ [snapshot]: http://git.ni.fr.eu.org/snapshots/pyfantom-master.tar.gz
+ [gitweb]: http://git.ni.fr.eu.org/?p=pyfantom.git;a=summary
+
+# 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).
+
+# How to use this wiki?
+
+This wiki is powered by [[ikiwiki]].
+
+You are encouraged to make changes, you just have to register or login using
+an already existing OpenID compatible account.
+
+All wikis are supposed to have a [[SandBox]], so this one does too.
+
+LEGO® is a trademark of the LEGO Group of companies which does not sponsor,
+authorize or endorse this site.