From 0cb7812c2b8b42df9b48f1d8537b16386ac1db92 Mon Sep 17 00:00:00 2001 From: Tat-Chee Wan (USM) Date: Fri, 3 Jun 2011 15:34:22 +0800 Subject: added setup information for package release --- README | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README (limited to 'README') 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) -- cgit v1.2.3