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 ae7912b501293d49a269eca31de4c42d4f8933a2..270f99ea53dc93dd42eb82bccfafbc95e2385781 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -14,12 +14,14 @@ You'll need the following Python modules:
 
 * Numpy_
 * Scipy_
+* PyYAML_ (for saving and loading playlists)
 * Matplotlib_ (for generating plots)
 * wxPython_ (for the GUI)
 
+.. _Python: http://www.python.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/
 
@@ -37,6 +39,7 @@ There is also a `GUI fork`_ (Rolf Schmidt)::
 And a `fork`_ versioned in Mercurial_ (W. Trevor King)::
 
     $ 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
@@ -65,6 +68,25 @@ to install Hooke.  Run::
 
 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
 =======================================