[Checkins] SVN: grok/trunk/INSTALL.txt Improve installation docs

Philipp von Weitershausen philikon at philikon.de
Wed Jul 25 14:32:32 EDT 2007


Log message for revision 78328:
  Improve installation docs
  

Changed:
  U   grok/trunk/INSTALL.txt

-=-
Modified: grok/trunk/INSTALL.txt
===================================================================
--- grok/trunk/INSTALL.txt	2007-07-25 17:14:03 UTC (rev 78327)
+++ grok/trunk/INSTALL.txt	2007-07-25 18:32:32 UTC (rev 78328)
@@ -1,8 +1,10 @@
 Preparing for grok development
 ------------------------------
 
-Grok is installed via buildout <http://cheeseshop.python.org/pypi/zc.buildout>.
+The Grok development sandbox is set up via `zc.buildout`_
 
+.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
+
 You may have setuptools already installed for your system Python. In
 that case, you may need to upgrade it first because buildout requires
 a very recent version::
@@ -21,14 +23,23 @@
 and run the buildout command::
 
     $ bin/buildout
-    [lots of stuff will be downloaded and installed locally here]
+    [lots of stuff will be downloaded and installed here]
 
+Note that if you have more than one sandbox for a Zope-based web
+application, it will probably make sense to share the eggs between the
+different sandboxes.  You can tell zc.buildout to use a central eggs
+directory by creating ``~/.buildout/default.cfg`` with the following
+contents::
+
+    [buildout]
+    eggs-directory = /home/bruno/buildout-eggs
+
 Running the demo applications
 -----------------------------
 
-Start the instance:
+You can start Zope with the demo applications installed with the
+following command:
 
-    $ cd parts/instance
     $ bin/zopectl fg
 
 If you now connect to port 8080 and log in with username 'grok',
@@ -46,3 +57,11 @@
 For functional tests we've set up a special test instance just for
 running the test from, which includes the minimum needed ZCML (so the
 tests run a tidbit faster).
+
+Generating the website files
+----------------------------
+
+Grok's tutorial documents for the website can easily be generated
+using the following script in ``bin``:
+
+    $ bin/grok2html /path/of/output/directory



More information about the Checkins mailing list