[Swift-commit] r2160 - trunk/docs

[noreply at svn.ci.uchicago.edu]

Author: benc
Date: 2008-07-30 08:46:33 -0500 (Wed, 30 Jul 2008)
New Revision: 2160

Modified:
   trunk/docs/README
Log:
more docbook README

Modified: trunk/docs/README
===================================================================
--- trunk/docs/README	2008-07-29 10:30:40 UTC (rev 2159)
+++ trunk/docs/README	2008-07-30 13:46:33 UTC (rev 2160)
@@ -19,8 +19,17 @@
 to place the docbook formatting stylesheets under the formatting/docbook/
 directory. This can be done with a symlink if docbook is installed elsewhere.
 
-For example, on benc's os x machine:
+For example:
 
+A) On the CI network, /home/hategan/docbook contains a docbook installation that
+can be linked like this:
+
+$ cd formatting
+$ ln -s /home/hategan/docbook/ docbook
+
+
+B) on benc's os x machine:
+
 # install docbook from DarwinPorts
 $ sudo port install docbook-xsl
 
@@ -29,10 +38,12 @@
 $ ln -s /opt/local/share/xsl/docbook-xsl/ docbook
 
 
-The buildguides.sh script will build all guides. Run it with no parameters,
-like this:
+Once the links are set up, the buildguides.sh script will build all guides
+as php.  Run it with no parameters, like this:
 
 $ ./buildguides.sh
 
-This will produced a .php file for each document. These files are
-sufficiently HTML-like that they can be opened in a local web browser.
+or use make to get HTML documents like this:
+
+$ make userguide.html
+