[Zope-CVS] SVN: zpkgtools/trunk/doc/quickstart.txt update the quick-start so it better matches the current state of affairs,

Fred L. Drake, Jr. fdrake at gmail.com
Wed Aug 10 19:21:36 EDT 2005


Log message for revision 37853:
  update the quick-start so it better matches the current state of affairs,
  and starts quicker
  

Changed:
  U   zpkgtools/trunk/doc/quickstart.txt

-=-
Modified: zpkgtools/trunk/doc/quickstart.txt
===================================================================
--- zpkgtools/trunk/doc/quickstart.txt	2005-08-10 23:10:19 UTC (rev 37852)
+++ zpkgtools/trunk/doc/quickstart.txt	2005-08-10 23:21:36 UTC (rev 37853)
@@ -7,7 +7,7 @@
 
 This is a very brief "getting started" guide to using the Zope 3
 package tool, |zpkg|_.  We'll start with simple instructions for
-building the ZopeX3 distribution.  These instructions only apply to
+building a Zope-3.1.X distribution.  These instructions only apply to
 Unix systems.
 
 The packaging tool builds a distribution pacakge based on *resources*.
@@ -42,9 +42,11 @@
 
 You will need to define a *resource map* to tell |zpkg|_ where package
 components can be found.  Resource maps can be loaded from local files
-or from remote locations specified by URL.  If you are primarily
-working with the Zope 3 packages, you should be able to use some
-prepared resource maps rather than defining your own.
+or from remote locations specified by URL.  The |zpkg|_ configuration
+file can contain a resource map as well, avoidin the need for a
+separate file.  If you are primarily working with the Zope 3 packages,
+you should be able to use some prepared resource maps rather than
+defining your own.
 
 The resource maps can be specified from the |zpkg|_ command line or in
 a configuration file.  It's generally easiest to work with a
@@ -59,15 +61,11 @@
   >>> os.path.expanduser('~')
   'C:\\Documents and Settings\\username'
 
-A good starting configuration to allow working with the resources
-defined for the Zope 3 project would be::
+If you're working with the Zope 3 source code (for Zope 3.1 or newer),
+a sample configuration with an embedded resource map is in the
+checked-out sources as *releases/Zope.cfg*.  Take a look at that for a
+moderately typical configuration.
 
-  # Resources for the Zope 3 project:
-  resource-map svn://svn.zope.org/repos/main/ReleaseSupport/trunk/PackageMaps/zope3.map
-
-  # Resources for use by zpkg:
-  resource-map svn://svn.zope.org/repos/main/ReleaseSupport/trunk/PackageMaps/support.map
-
 Read more about resource maps in |zpkg|_, and about how resource
 locations are specified in `Resource Locations <resources.html>`_.
 
@@ -81,11 +79,10 @@
 
 Run |zpkg|_ using this command::
 
-  zpkg -ac -vVERSION ZopeX3
+  zpkg -C releases/Zope.cfg -vVERSION Zope
 
-After listening to a good CD, or perhaps having some good Thai food,
-you should find a very large tarball named *ZopeX3-VERSION.tgz* in the
-current directory.
+After a short while, you should find a very large tarball named
+*Zope-VERSION.tgz* in the current directory.
 
 
 Defining a New Resource
@@ -208,7 +205,7 @@
 The format of the file is simply a series of RFC 2822 headers, with
 the header names matching the field names.  For example::
 
-  Name: Zope X3
+  Name: Zope
   Summary: Zope 3 Application Server
   Home-page: http://dev.zope.org/Zope3/
   Author: Zope Corporation and Contributors



More information about the Zope-CVS mailing list