Code

Adapt metakit backend to new security scheme.
[roundup.git] / doc / installation.txt
index e61279a3187233daedad9f183adb9af5e403a88b..374f829758792d82f4ff4ab809c8d1497f2d8f4b 100644 (file)
@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.11 $
+:Version: $Revision: 1.14 $
 
 .. contents::
 
@@ -66,9 +66,13 @@ later. Download the latest version from http://pybsddb.sourceforge.net/.
 Testing your Python
 -------------------
 
-Run ``"python ./run_tests"`` and make sure there
+Run ``python ./run_tests`` and make sure there
 are no errors.  If there are errors, please let us know!
 
+If the above fails, you may be using the wrong version of python. Try
+``python2 ./run_tests``. If that works, you will need to substitute
+``python2`` for ``python`` in all further commands you use in relation to
+Roundup -- from installation and scripts.
 
 Getting Roundup
 ===============
@@ -79,7 +83,8 @@ Download the latest version from http://roundup.sf.net/.
 Installation
 ============
 
-Set aside 15-30 minutes.
+Set aside 15-30 minutes. Please make sure you're using a supported version of
+Python -- see `testing your python`_.
 
 1. To install the Roundup support code into your Python tree and
    Roundup scripts into /usr/local/bin::
@@ -181,7 +186,14 @@ Set aside 15-30 minutes.
 
      echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE
 
-TODO (finish)
+
+Upgrading
+=========
+
+Read the separate `upgrading document`_, which describes the steps needed to
+upgrade existing tracker instances for each version of Roundup that is
+released.
+
 
 ZRoundup
 ========
@@ -242,4 +254,5 @@ Next: `Getting Started`_
 .. _`getting started`: getting_started.html
 .. _`roundup specification`: spec.html
 .. _`customising roundup`: customizing.html
+.. _`upgrading document`: upgrading.html