Setup package for setuptools distribution.

[FFT-tools.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f634e53
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+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.
+
+
+== Installation ==
+
+Non-Python dependencies (Debian packagename):
+  easy_install  (python-setuptools)
+  Numpy source  (python-numpy-dev)
+
+FFT_tools 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
+
+There is one speedbump you might run into:
+  * an outdated version of easy_install (see ez_setup.py section)
+
+** ez_setup.py
+
+This package bundles
+  http://peak.telecommunity.com/dist/ez_setup.py
+to bootstrap setuputils installation on your machine (if neccessary).
+
+If the bootstrapping doesn't work, you may need to install a current version
+of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
+Once you have *some* version of setuptools, upgrade with
+  easy_install -U setuptools
+
+For more information see
+  http://peak.telecommunity.com/DevCenter/EasyInstall
+  http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+
+
+== Usage ==
+
+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/
+
+
+== Author ==
+
+W. Trevor King
+wking@drexel.edu
+Copyright 2007, 2008