SVN: r22360 - trunk/quixote/doc

Author: nascheme
Date: 2003-08-29 16:29:22 -0400 (Fri, 29 Aug 2003)
New Revision: 22360

Modified:
   trunk/quixote/doc/INSTALL.txt
Log:
Integrate improved instructions (from Greg Ward).


Modified: trunk/quixote/doc/INSTALL.txt
===================================================================
--- trunk/quixote/doc/INSTALL.txt	2003-08-28 23:11:07 UTC (rev 22359)
+++ trunk/quixote/doc/INSTALL.txt	2003-08-29 20:29:22 UTC (rev 22360)
@@ -1,46 +1,53 @@
 Installing Quixote
 ==================
 
-To install Quixote, two steps are required. 
+Best-case scenario
+------------------
 
-1) (Python 2.0 and 2.1 only)
-   Install the compiler code from the Python source distribution.
-2) Install the ``quixote`` Python package.  
+If you are using Python 2.2 or later, and have never installed Quixote
+with your current version of Python, you're in luck.  Just run
 
+  python setup.py install
 
-Installing the compiler code
-----------------------------
+and you're done.  Proceed to the demo documentation to learn how to get
+Quixote working.
 
-Python contains a set of modules -- the ``compiler`` package -- for
-parsing Python source code and generating Python bytecode, and the PTL
-compiler is built on top of it.  With Python 2.0 and 2.1, this package
-was included in Python's source distribution, but not installed as part
-of the standard library.
+If you're using an older Python, or if you're upgrading from an older
+Quixote version, read on.
 
-Thus, if you haven't upgraded to Python 2.2 yet, you'll need to install
-the ``compiler`` package yourself.  Assuming your Python source
-distribution is in ``/tmp/Python-2.1.2``::
 
-    cd /tmp/Python-2.1.2/Tools/compiler
-    python setup.py install
+Upgrading from an older Quixote version
+---------------------------------------
 
-(Obviously, you'll have to adjust this to reflect your Python version
-and where you kept the source distribution after installing Python.)
+We strongly recommend that you remove any old Quixote version before
+installing a new one.  First, find out where your old Quixote
+installation is:
 
-If you're running Python 2.2 (or later), this step is unnecessary.
+  python -c "import os, quixote; print os.path.dirname(quixote.__file__)"
 
+and then remove away the reported directory.  (If the import fails, then
+you don't have an existing Quixote installation.)
 
-Installing the quixote package
-------------------------------
+Then proceed as above:
 
-Quixote 0.6 changes the ``quixote.form.form`` module from PTL to
-Python code.  You should delete or move the existing ``quixote/``
-directory in ``site-packages`` before running ``setup.py``, or at
-least delete the old ``form.ptl`` and ``form.ptlc`` files.
+  python setup.py install
 
-Simply run::
 
+Using Quixote with Python 2.0 or 2.1
+------------------------------------
+
+If you are using Python 2.0 or 2.1 then you need to install the
+``compiler`` package from the Python source distribution.  The
+``compiler`` package is for parsing Python source code and generating
+Python bytecode, and the PTL compiler is built on top of it.  With
+Python 2.0 and 2.1, this package was included in Python's source
+distribution, but not installed as part of the standard library.
+
+Assuming your Python source distribution is in ``/tmp/Python-2.1.2``::
+
+    cd /tmp/Python-2.1.2/Tools/compiler
     python setup.py install
 
-The ``quixote`` package and its subpackages will be copied into the
-appropriate directory for site-specific packages.
+(Obviously, you'll have to adjust this to reflect your Python version
+and where you kept the source distribution after installing Python.)
+