Renamed bin/hooke -> bin/hk.py.
[hooke.git] / doc / install.txt
index a8b754c06dd1a6efe0ffffd4d8cccafa091239a4..ae7912b501293d49a269eca31de4c42d4f8933a2 100644 (file)
@@ -6,9 +6,9 @@ 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.
+systems. It is possible to run it happily on Mac OS X (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:
 
@@ -17,11 +17,11 @@ You'll need the following Python modules:
 * 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/
+.. _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
 ==================
@@ -32,24 +32,24 @@ Hooke_ is available as an Subversion_ repository::
 
 There is also a `GUI fork`_ (Rolf Schmidt)::
 
-    $ svn checkout http://hooke.googlecode.com/svn/trunk/ hooke
+    $ svn checkout http://hooke.googlecode.com/svn/branches/illysam/ hooke
 
-And a `fork`_ versioned in Git_ (W. Trevor King)::
+And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
 
-    $ git clone http://www.physics.drexel.edu/~wking/code/git/hooke.git/ hooke
+    $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/ 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
+     $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
      $ 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
+.. _fork: http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/
 .. _Subversion: http://subversion.tigris.org/
-.. _Git: http://git-scm.com/
+.. _Mercurial: http://mercurial.selenic.com/
 
 
 Installation
@@ -71,7 +71,11 @@ 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
+     $ wget -O hooke.zip http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/archive/tip.zip
      $ unzip hooke.zip
      $ cd hooke
-     $ python bin/hooke
+     $ python bin/hk.py
+
+You may need to give the full path for Python on Windows systems, and
+also check that the current working directory (`.`) is in your
+`PYTHONPATH`.  See :manpage:`python(1)` for details.