[Checkins] SVN: grokui.admin/trunk/ Update documentation.

Uli Fouquet uli at gnufix.de
Thu Jul 10 16:20:54 EDT 2008


Log message for revision 88199:
  Update documentation.

Changed:
  U   grokui.admin/trunk/INSTALL.txt
  U   grokui.admin/trunk/README.txt
  U   grokui.admin/trunk/src/grokui/admin/README.txt

-=-
Modified: grokui.admin/trunk/INSTALL.txt
===================================================================
--- grokui.admin/trunk/INSTALL.txt	2008-07-10 19:09:18 UTC (rev 88198)
+++ grokui.admin/trunk/INSTALL.txt	2008-07-10 20:20:52 UTC (rev 88199)
@@ -1,23 +1,39 @@
-============================================
 Installing the grok admin and development UI
-============================================
+********************************************
 
-Pre-requisites
---------------
+Prerequisites
+=============
 
 These istructions assume a Linux installation with python2.4, easy_install, 
 and setuptools.
 
+grokui.admin user installation
+==============================
 
-grokadmin installation
-----------------------
+These steps are for 'users' of the package. Follow it, if you simply
+want to use the package in your own project.
 
-1. Checkout the grokadmin code and move to the directory created::
+1. Update your project's `setup.py`.
 
-    $ svn co svn://svn.zope.org/repos/main/Sandbox/ulif/grokadmin grokadmin
-    $ cd grokadmin
+   Add `grokui.admin` to the required packages in your `setup.py`.
 
+When rerunning `buildout` afterwards, the package should be fetched
+and installed in your local eggs repository.
 
+
+grokui.admin development installation
+=====================================
+
+These steps are for users that want to develop the package
+further. To use this package in another package have a look at the
+section above.
+
+1. Checkout the grokui.admin code and move to the directory created::
+
+    $ svn co svn://svn.zope.org/repos/main/grokui.admin/trunk grokui.admin
+    $ cd grokui.admin
+
+
 2. Invoke the bootstrap script with python2.4::
 
     $ python2.4 bootstrap/bootstrap.py

Modified: grokui.admin/trunk/README.txt
===================================================================
--- grokui.admin/trunk/README.txt	2008-07-10 19:09:18 UTC (rev 88198)
+++ grokui.admin/trunk/README.txt	2008-07-10 20:20:52 UTC (rev 88199)
@@ -1,2 +1,2 @@
-see src/grokadmin/README.txt
+see src/grokui.admin/README.txt
 

Modified: grokui.admin/trunk/src/grokui/admin/README.txt
===================================================================
--- grokui.admin/trunk/src/grokui/admin/README.txt	2008-07-10 19:09:18 UTC (rev 88198)
+++ grokui.admin/trunk/src/grokui/admin/README.txt	2008-07-10 20:20:52 UTC (rev 88199)
@@ -1,6 +1,5 @@
-=====================
 A basic grok admin UI
-=====================
+*********************
 
 The internal name of the admin UI is:
 Grok Application Interface Application or, for short GAIA.
@@ -11,7 +10,7 @@
 
 
 Login - what is my username/password?
--------------------------------------
+=====================================
 
 Before you can use the admin UI, you first must log in.
 
@@ -27,7 +26,7 @@
 
 
 Using the admin-UI
-------------------
+==================
 
 After login you can visit some of the main management topics, as
 described below:
@@ -37,7 +36,7 @@
 
 
 Applications
-------------
+============
 
 * List of all instanciated applications
 
@@ -57,7 +56,7 @@
 
 
 Server
-------
+======
 
 * Start/Restart the server. Caution! This does not work, if the server
   was started in 'foreground mode' (with 'zopectl fg').
@@ -70,7 +69,7 @@
 
 
 Documentation
--------------
+=============
 
 * From here you get starting points to the more elaborated
   documentation features of Grok, namely:
@@ -86,7 +85,7 @@
 
 
 Bugs, Caveats and Ways to Get Help
-----------------------------------
+==================================
 
 The Grok admin UI was developed basically during a Google Summer of
 Code project.
@@ -101,9 +100,9 @@
 
     http://lists.zope.org.
 
-The projects' home is the grok subversion repository at:
+The projects' home is the subversion repository at:
 
-    http://svn.zope.org/grok/
+    http://svn.zope.org/grokui.admin/
 
 Grok's cave can be found at
 



More information about the Checkins mailing list