[Commits] r565 - website

[commits at geoext.org]

Author: tschaub
Date: 2009-05-01 02:42:14 +0200 (Fri, 01 May 2009)
New Revision: 565

Modified:
   website/README.txt
Log:
updating readme with a bit more detail

Modified: website/README.txt
===================================================================
--- website/README.txt	2009-05-01 00:24:25 UTC (rev 564)
+++ website/README.txt	2009-05-01 00:42:14 UTC (rev 565)
@@ -9,8 +9,7 @@
 Basic self contained install from source::
 
     you at prompt:~/$ cd GeoExtSite
-    you at prompt:~/GeoExtSite$ python setup_website; . bin/activate
-    (GeoExtSite):~/GeoExtSite$
+    you at prompt:~/GeoExtSite$ python2.5 setup_website
 
 This will make the directory GeoExtSite into a contained development
 enviroment. For convenience, you can "activate" this environment and
@@ -20,7 +19,17 @@
     (GeoExtSite):~/GeoExtSite$ echo $PATH
     /Users/you/GeoExtSite/bin:...  
 
+Important note, before running any of the commands below, and whenever returning
+to this directory to repeat any of the paver commands, make sure to activate
+your virtual environment.
 
+    you at prompt:~/GeoExtSite$ . bin/activate
+    (GeoExtSite):~/GeoExtSite$
+
+To deactivate *(do not deactivate before running paver commands below)*, run the
+``deactivate`` command.
+
+
 Paver
 -----
 
@@ -36,19 +45,26 @@
 
 From the GeoExtSite directory, run the following to build the html docs::
 
-    (GeoExtSite)you at prompt:~/GeoExtSite$ paver checkup_docs
     (GeoExtSite)you at prompt:~/GeoExtSite$ paver build_docs
 
-To rebuild the docs without the svn update, run just the following::
+This will check out the latest GeoExt code and doc sources.  You can rebuild the
+docs at any time with the above command.  If you need to grab an update from the
+repository before building docs, run the following::
 
+    (GeoExtSite)you at prompt:~/GeoExtSite$ paver checkup_docs
     (GeoExtSite)you at prompt:~/GeoExtSite$ paver build_docs
 
 
 Serving Website
 ---------------
 
+The paver tasks above build a static website with html and associated resources.
+You can view this site in a browser by navigating to the www directory in the
+GeoExtSite directory.  If you don't have a web server running, you can still
+view the docs in any browser (e.g. file:///path/to/GeoExtSite/www/index.html).
+
 If you have a web server running that has access to the GeoExtSite directory,
-you can browse the built docs (e.g. http://localhost/path/to/GeoExtSite/www/docs).
+you can browse the built docs (e.g. http://localhost/path/to/GeoExtSite/www/index.html).
 
 If you don't have a web server running that can access the docs, you can run
 one from the website environment::
@@ -58,6 +74,5 @@
 Then surf to :
 
    http://localhost:8080/
-   http://localhost:8080/docs
-   http:/localhost:8080/trac
+   http://localhost:8080/trac