[pypy-svn] rev 1056 - pypy/trunk/doc

[anna at codespeak.net]

Author: anna
Date: Tue Jun 24 16:32:12 2003
New Revision: 1056

Modified:
   pypy/trunk/doc/readme.txt
Log:
added more reST howto information

Modified: pypy/trunk/doc/readme.txt
==============================================================================
--- pypy/trunk/doc/readme.txt	(original)
+++ pypy/trunk/doc/readme.txt	Tue Jun 24 16:32:12 2003
@@ -42,7 +42,29 @@
 
 You can get more info on reST markup at http://docutils.sourceforge.net/docs/rst/quickref.html
 
-Here are some sample textfiles:
+------------------------
+Checking your work
+------------------------
+
+In order to make sure that what you commit looks reasonably pretty (or at least not entirely broken), you'll need to run the ``docutils`` parser on it. Unless you've installed it in the past, you probably don't have it installed. Open IDLE (or any Python interactive environment) and try "import docutils". If it imports, hooray! Otherwise, you'll need to download it.
+
+Go to sourceforge and download the snapshot version. Install it.
+
+*Note to Debian users:* Be sure you have ``distutils`` installed and working before trying to install ``docutils``.
+
+Once you have ``docutils`` installed, you can use it go to your shell and use it like this::
+
+ $ python ~/mypath/docutils/tools/buildhtml.py
+ /// Processing directory: /home/anna/downloads/arObjSpaceDoc
+     ::: Processing .txt: howtosvn.txt
+     ::: Processing .txt: index.txt
+
+**WARNING** This will process **all** text documents in the directory and any subdirectories. I prefer to work on text in a separate directory, run the ``docutils`` parser to see what it looks like, then copy the .txt file over to my local /doc checkouts to commit it.
+
+Use a browser to File:Open:filename.html then you can see what it looks like. Look at the command shell to see what errors you've got on which lines and fix it in your textfile. You can then re-run the buildhtml.py script and see what errors you get. After it's fixed, you can commit the .txt file and it'll automagically be turned into html viewable on the website.
+
+
+Here are some sample reST textfiles to see what it looks like:
 
 + ObjectSpace_
 + ObjectSpaceInterface_