Began versioning.

[stepper.git] / README

diff --git a/README b/README
index f634e53b911267ffa627b8b92ca95ac2ba33dc7e..48803580c6223f4d0be718332bafe86e54fc2cab 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,22 @@
-This package wraps Numpy's fft module to produce unitary transforms
-and power spectra of real numbers in one dimension.  See the code for
-the technical details.
-
+This package provides Python control of stepper motors.  See Jones'
+"Control of Stepping Motors" for an excellent stepper overview.
+  http://www.cs.uiowa.edu/~jones/step/
+Supports full and half stepping of motors with one or two power lines
+and 4 drains, or one or two drains and 4 power lines...  Basically any
+motor with 4 variable lines, and it would be easy to extend it to
+other cases.
 
 == Installation ==
 
 Non-Python dependencies (Debian packagename):
   easy_install  (python-setuptools)
-  Numpy source  (python-numpy-dev)
 
-FFT_tools uses `setuptools' for installation.  Setuptools is basically
+Stepper uses `setuptools' for installation.  Setuptools is basically
 an extension of the standard Python distutils package which supports
 automatic package dependency tracking.  The installation procedure
 should be (on Debian-esque systems)
   # apt-get intall python-setuptools python-numpy-dev
-  # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ FFT_tools
+  # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ stepper
 
 There is one speedbump you might run into:
   * an outdated version of easy_install (see ez_setup.py section)
@@ -42,12 +44,12 @@ See the tests in FFT_tools.py for simple examples.
 
 == Licence ==
 
-This project is distributed under the Python Software Foundation License.
-http://www.python.org/psf/license/
+This project is distributed under the BSD License.
+  http://www.fsf.org/licensing/licenses/#ModifiedBSD
 
 
 == Author ==
 
 W. Trevor King
 wking@drexel.edu
-Copyright 2007, 2008
+Copyright 2008, 2009