Added Sphinx documentation framework

[hooke.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
new file mode 100644 (file)
index 0000000..a8b754c
--- /dev/null
+++ b/doc/install.txt
@@ -0,0 +1,77 @@
+****************
+Installing Hooke
+****************
+
+Dependencies
+============
+
+Hooke is routinely run successfully on Windows and Linux based
+systems. It is possible to run it happily on Mac OS X too (though
+install can be a bit trickier). Technically, Hooke should run wherever
+the Python_ programming language is installed.
+
+You'll need the following Python modules:
+
+* Numpy_
+* Scipy_
+* Matplotlib_ (for generating plots)
+* wxPython_ (for the GUI)
+
+.. Numpy: http://numpy.scipy.org/
+.. Scipy: http://www.scipy.org/
+.. Python: http://www.python.org/
+.. Matplotlib: http://matplotlib.sourceforge.net/
+.. wxPython: http://www.wxpython.org/
+
+Getting the source
+==================
+
+Hooke_ is available as an Subversion_ repository::
+
+    $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
+
+There is also a `GUI fork`_ (Rolf Schmidt)::
+
+    $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
+
+And a `fork`_ versioned in Git_ (W. Trevor King)::
+
+    $ git clone http://www.physics.drexel.edu/~wking/code/git/hooke.git/ hooke
+
+There are also periodic bundled releases.  See the homepage for each
+fork for details.  For example, get the most recent snapshot of
+Trevor's fork in zip form with::
+
+     $ wget -o hooke.zip http://www.physics.drexel.edu/~wking/code/git/git.php?p=hooke.git&dl=zip&h=HEAD
+     $ unzip hooke.zip
+
+.. _Hooke: http://code.google.com/p/hooke/
+.. _GUI fork: http://code.google.com/p/hooke/wiki/HookeGUI
+.. _fork: http://www.physics.drexel.edu/~wking/code/git/git.php?p=hooke.git
+.. _Subversion: http://subversion.tigris.org/
+.. _Git: http://git-scm.com/
+
+
+Installation
+============
+
+Run::
+
+    $ python setup.py install
+
+to install Hooke.  Run::
+
+    $ python setup.py install --help
+
+to see a list of installation options you may want to configure.
+
+Running Hooke from the source directory
+=======================================
+
+If you like, you can avoid installation by running Hooke directly from
+it's source directory::
+
+     $ wget -o hooke.zip http://www.physics.drexel.edu/~wking/code/git/git.php?p=hooke.git&dl=zip&h=HEAD
+     $ unzip hooke.zip
+     $ cd hooke
+     $ python bin/hooke