[Checkins] SVN: Sandbox/baijum/bluebream/trunk/README.txt Add all option details

Baiju Muthukadan cvs-admin at zope.org
Mon Jan 4 01:45:10 EST 2010


Log message for revision 107616:
  Add all option details
  

Changed:
  U   Sandbox/baijum/bluebream/trunk/README.txt

-=-
Modified: Sandbox/baijum/bluebream/trunk/README.txt
===================================================================
--- Sandbox/baijum/bluebream/trunk/README.txt	2010-01-04 06:20:01 UTC (rev 107615)
+++ Sandbox/baijum/bluebream/trunk/README.txt	2010-01-04 06:45:10 UTC (rev 107616)
@@ -1,3 +1,6 @@
+.. contents:: Table of Contents
+   :depth: 2
+
 BlueBream
 *********
 
@@ -8,6 +11,9 @@
 BlueBream generate a project directory from a template called
 ``bluebream``.  The template is created using `PasteScript
 <http://pythonpaste.org/script/developer.html>`_ by Ian Bicking.
+Deatailed documentation about BlueBream is available here:
+`http://packages.python.org/bluebream
+<http://packages.python.org/bluebream>`_
 
 Features
 --------
@@ -19,7 +25,7 @@
 
 3. Functional testing enabled by default using z3c.testsetup
 
-4. Use PasteDeploy
+4. Use PasteDeploy to support WSGI based deployment.
 
 5. Create a namespace package by default.
 
@@ -54,6 +60,28 @@
 
   $ paster create -t bluebream sampleproject namespace_package=mycompany
 
+The other variables which can be given from command line are:
+
+- version: Version (like 0.1)
+
+- description: One-line description of the package
+
+- long_description: Multi-line description (in reST)
+
+- keywords: Space-separated keywords/tags
+
+- author: Author name
+
+- author_email: Author email
+
+- url: URL of homepage
+
+- license_name: License name
+
+- zip_safe: ``True``, if the package can be distributed as a .zip
+  file othewise ``False``.
+
+
 Usage
 -----
 
@@ -75,6 +103,5 @@
 
   $ ./bin/paster serve debug.ini
 
-For testing purpose, you can access the "hello" view registered here:
-http://localhost:8080/@hello
-
+There is a view named ``hello`` registered by default. which can be
+accessed here: http://localhost:8080/@@hello



More information about the checkins mailing list