Began versioning.
[stepper.git] / README
1 This package provides Python control of stepper motors.  See Jones'
2 "Control of Stepping Motors" for an excellent stepper overview.
3   http://www.cs.uiowa.edu/~jones/step/
4 Supports full and half stepping of motors with one or two power lines
5 and 4 drains, or one or two drains and 4 power lines...  Basically any
6 motor with 4 variable lines, and it would be easy to extend it to
7 other cases.
8
9 == Installation ==
10
11 Non-Python dependencies (Debian packagename):
12   easy_install  (python-setuptools)
13
14 Stepper uses `setuptools' for installation.  Setuptools is basically
15 an extension of the standard Python distutils package which supports
16 automatic package dependency tracking.  The installation procedure
17 should be (on Debian-esque systems)
18   # apt-get intall python-setuptools python-numpy-dev
19   # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ stepper
20
21 There is one speedbump you might run into:
22   * an outdated version of easy_install (see ez_setup.py section)
23
24 ** ez_setup.py
25
26 This package bundles
27   http://peak.telecommunity.com/dist/ez_setup.py
28 to bootstrap setuputils installation on your machine (if neccessary).
29
30 If the bootstrapping doesn't work, you may need to install a current version
31 of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
32 Once you have *some* version of setuptools, upgrade with
33   easy_install -U setuptools
34
35 For more information see
36   http://peak.telecommunity.com/DevCenter/EasyInstall
37   http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
38
39
40 == Usage ==
41
42 See the tests in FFT_tools.py for simple examples.
43
44
45 == Licence ==
46
47 This project is distributed under the BSD License.
48   http://www.fsf.org/licensing/licenses/#ModifiedBSD
49
50
51 == Author ==
52
53 W. Trevor King
54 wking@drexel.edu
55 Copyright 2008, 2009