Add os.path.expanduser() wrappers to user-supplied paths.

[hooke.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
index 201fff699ae1a755f7c43047730049bfb4678e7f..270f99ea53dc93dd42eb82bccfafbc95e2385781 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -14,12 +14,14 @@ You'll need the following Python modules:
 
 * Numpy_
 * Scipy_
 
 * Numpy_
 * Scipy_

+* PyYAML_ (for saving and loading playlists)

 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)
 
 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)
 

+.. _Python: http://www.python.org/

 .. _Numpy: http://numpy.scipy.org/
 .. _Scipy: http://www.scipy.org/
 .. _Numpy: http://numpy.scipy.org/
 .. _Scipy: http://www.scipy.org/

-.. _Python: http://www.python.org/
+.. _PyYAML: http://pyyaml.org/

 .. _Matplotlib: http://matplotlib.sourceforge.net/
 .. _wxPython: http://www.wxpython.org/
 
 .. _Matplotlib: http://matplotlib.sourceforge.net/
 .. _wxPython: http://www.wxpython.org/
 


@@ -36,7 +38,8 @@ There is also a `GUI fork`_ (Rolf Schmidt)::
 
 And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
 
 
 And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
 

-    $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hooke/ hooke
+    $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hgwebdir.cgi/hooke/ hooke
+    $ hg update wtk

 
 There are also periodic bundled releases.  See the homepage for each
 fork for details.  For example, get the most recent snapshot of
 
 There are also periodic bundled releases.  See the homepage for each
 fork for details.  For example, get the most recent snapshot of


@@ -65,17 +68,36 @@ to install Hooke.  Run::
 
 to see a list of installation options you may want to configure.
 
 
 to see a list of installation options you may want to configure.
 

+If you install Hooke, you should probably setup a system- or user-wide
+configuration file (:doc:`config`), and replace any relative paths
+with appropriate absolute paths.  For example::
+
+    # Commands for managing a command stack (similar to macros).
+    [command_stack plugin]
+    # Directory containing command stack files.
+    path = resources/command_stack
+
+    # wxWindows graphical user interface.
+    [gui user interface]
+    # Path to the hooke icon image.
+    icon image = /usr/share/hooke/doc/img/microscope.ico
+    # Path to the Hooke splash screen image.
+    splash screen image = /usr/share/hooke/doc/img/hooke.jpg
+    # Directory containing perspective files.
+    perspective path = ~/.hooke/resources/gui/perspective
+
+

 Running Hooke from the source directory
 =======================================
 
 If you like, you can avoid installation by running Hooke directly from
 it's source directory::
 
 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
      $ 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
 
 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 `python(1)` for details.
+`PYTHONPATH`.  See :manpage:`python(1)` for details.