1 files changed, 37 insertions, 0 deletions
diff --git a/python/python3-nxt-python/README b/python/python3-nxt-python/README
new file mode 100644
index 0000000000000..45dd72cbd4314
--- /dev/null
+++ b/python/python3-nxt-python/README
@@ -0,0 +1,37 @@
+nxt-python (python module to control Lego NXT)
+
+nxt-python is a python 2.x driver/interface for the Lego Mindstorms
+NXT robot.
+
+Setup
+------
+
+In order to use nxt-python with an NXT kit, you should add a 'lego'
+group to your system, and add yourself to that group:
+
+    # groupadd lego
+    # usermod -a -G lego YourUserName
+
+You will also want to set up a udev rule to identify NXT hardware and
+grant the 'lego' group permission to use it.
+
+A sample rule is included for you in /usr/share/python3-nxt-python,
+but you should verify the vendor code of the NXT unit.
+
+To verify a vendor code, connect the NXT hardware to your computer
+and then run:
+
+    # lsusb
+
+Look at the ID for the Lego device; it will probably be 0694, but if not,
+then change the value in the sample udev rule to match.
+
+Save the sample udev rule (70-lego.rules) to /etc/udev/rules.d/
+
+Log out and log back in, and you should now have full control, via Python,
+over your NXT hardware.
+
+Requires at least one of these
+-------------------------------
+python3-pyusb (for USB communication)
+python3-pybluez (for bluetooth communication)