Commits

Jason R. Coombs committed 23db060

Moved readme to root of package to match convention

Comments (0)

Files changed (3)

+.. -*- restructuredtext -*-
+
+``jaraco.nxt`` - LEGO Mindstorms NXT Bluetooth API in Python
+============================================================
+
+.. contents::
+
+Status and License
+------------------
+
+``jaraco.nxt`` implements the LEGO Mindstorms NXT Bluetooth API in Python.
+
+``jaraco.nxt`` is written by Jason R. Coombs.  It is licensed under an
+`MIT-style permissive license
+<https://svn.jaraco.com/jaraco/python/jaraco.nxt/docs/license.txt>`_.
+
+You can install it with ``easy_install jaraco.nxt``, or from the
+`subversion repository
+<https://svn.jaraco.com/jaraco/python/jaraco.nxt#egg=jaraco.nxt-dev>`_ with
+``easy_install jaraco.nxt==dev``.
+
+The ``jaraco.nxt`` library also can take advantage of the `jaraco input
+<http://pypi.python.org/pypi/jaraco.input>`_ 
+package.  To include it as part of the install, use the command
+``easy_install jaraco.nxt[input]``.
+
+Getting Started
+---------------
+
+``jaraco.nxt`` provides a message class for sending and receiving messages
+with the Lego NXT device.  First pair the device with your PC by following
+the instructions included with the device.  Then, determine the COM port
+to which it is connected.  The hello world example is to retrieve the battery
+voltage.  You can `download the source
+<https://svn.jaraco.com/jaraco/python/jaraco.nxt/examples/get_battery_voltage.py>`_
+for that example.  You may also `browse the other examples
+<https://svn.jaraco.com/jaraco/python/jaraco.nxt/examples>`_.
+
+For more information, read the docstrings of the modules in the packages.
+
+Modules of interest are
+
+* jaraco.nxt.messages: implements the messages defined by
+  the NXT Bluetooth protocol.
+* jaraco.nxt.controller: demonstrates how to link input from
+  a joystick to messages controlling the motors.  Uses jaraco.input.
+
+Changes
+-------
+
+1.3.1
+~~~~~
+
+* Bug fixes in messages.MessageWrite.
+
+1.3
+~~~
+
+* Added device discovery and support for Bluetooth Sockets using the
+  PyBluez package.
+
+1.2.2
+~~~~~
+
+* Removed dependence on enum and jaraco.util
+
+1.2
+~~~
+
+* Added this documentation
+* Updated the project website to use PYPI directly.
+* Moved joystick functionality to its own project - `jaraco.input
+  <http://pypi.python.org/pypi/jaraco.input>`_
+
+1.1
+~~~
+
+* Updated dependency on jaraco.util, removing many secondary dependencies.
+
+1.0
+~~~
+
+* Initial release
+* Implements complete protocol
+* Includes support for XBox 360 controller on Windows

docs/index.txt

-``jaraco.nxt`` - LEGO Mindstorms NXT Bluetooth API in Python
-============================================================
-
-.. contents::
-
-Status and License
-------------------
-
-``jaraco.nxt`` implements the LEGO Mindstorms NXT Bluetooth API in Python.
-
-``jaraco.nxt`` is written by Jason R. Coombs.  It is licensed under an
-`MIT-style permissive license
-<https://svn.jaraco.com/jaraco/python/jaraco.nxt/docs/license.txt>`_.
-
-You can install it with ``easy_install jaraco.nxt``, or from the
-`subversion repository
-<https://svn.jaraco.com/jaraco/python/jaraco.nxt#egg=jaraco.nxt-dev>`_ with
-``easy_install jaraco.nxt==dev``.
-
-The ``jaraco.nxt`` library also can take advantage of the `jaraco input
-<http://pypi.python.org/pypi/jaraco.input>`_ 
-package.  To include it as part of the install, use the command
-``easy_install jaraco.nxt[input]``.
-
-Getting Started
----------------
-
-``jaraco.nxt`` provides a message class for sending and receiving messages
-with the Lego NXT device.  First pair the device with your PC by following
-the instructions included with the device.  Then, determine the COM port
-to which it is connected.  The hello world example is to retrieve the battery
-voltage.  You can `download the source
-<https://svn.jaraco.com/jaraco/python/jaraco.nxt/examples/get_battery_voltage.py>`_
-for that example.  You may also `browse the other examples
-<https://svn.jaraco.com/jaraco/python/jaraco.nxt/examples>`_.
-
-For more information, read the docstrings of the modules in the packages.
-
-Modules of interest are
-
-* jaraco.nxt.messages: implements the messages defined by
-  the NXT Bluetooth protocol.
-* jaraco.nxt.controller: demonstrates how to link input from
-  a joystick to messages controlling the motors.  Uses jaraco.input.
-
-Changes
--------
-
-1.3.1
-~~~~~
-
-* Bug fixes in messages.MessageWrite.
-
-1.3
-~~~
-
-* Added device discovery and support for Bluetooth Sockets using the
-  PyBluez package.
-
-1.2.2
-~~~~~
-
-* Removed dependence on enum and jaraco.util
-
-1.2
-~~~
-
-* Added this documentation
-* Updated the project website to use PYPI directly.
-* Moved joystick functionality to its own project - `jaraco.input
-  <http://pypi.python.org/pypi/jaraco.input>`_
-
-1.1
-~~~
-
-* Updated dependency on jaraco.util, removing many secondary dependencies.
-
-1.0
-~~~
-
-* Initial release
-* Implements complete protocol
-* Includes support for XBox 360 controller on Windows
 	name = name,
 	use_hg_version=True,
 	description = 'Logo Mindstorms NXT Routines',
-	long_description = open('docs/index.txt').read().strip(),
+	long_description = open('README').read().strip(),
 	author = 'Jason R. Coombs',
 	author_email = 'jaraco@jaraco.com',
 	url = 'http://pypi.python.org/pypi/'+name,