[Checkins] SVN: Sandbox/darrylcousins/mars.layer/s Documentation changes

[Darryl Cousins]

Log message for revision 77808:
  Documentation changes

Changed:
  U   Sandbox/darrylcousins/mars.layer/setup.py
  U   Sandbox/darrylcousins/mars.layer/src/mars/layer/README.txt

-=-
Modified: Sandbox/darrylcousins/mars.layer/setup.py
===================================================================
--- Sandbox/darrylcousins/mars.layer/setup.py	2007-07-13 08:59:45 UTC (rev 77807)
+++ Sandbox/darrylcousins/mars.layer/setup.py	2007-07-13 09:01:50 UTC (rev 77808)
@@ -26,21 +26,16 @@
     extras_require = dict(
                 test=['zope.app.testing',
                       'zope.testbrowser',
-# these added because used by z3c.layer test layer setup
                       'zope.app.zcmlfiles',
                       'zope.app.securitypolicy',
                       'zope.app.authentication',
                       'z3c.pagelet',
-# end
         ]
                 ),
     install_requires = [
         'setuptools',
-# these added because used by grok
         'zope.app.intid',
         'zope.app.catalog',
-# end
-# these added because used by mars.layer
         'zope.component',
         'zope.interface',
         'zope.publisher',
@@ -49,6 +44,5 @@
         'z3c.form',
         'z3c.formui',
         'z3c.layer',
-# end
         ],
 )

Modified: Sandbox/darrylcousins/mars.layer/src/mars/layer/README.txt
===================================================================
--- Sandbox/darrylcousins/mars.layer/src/mars/layer/README.txt	2007-07-13 08:59:45 UTC (rev 77807)
+++ Sandbox/darrylcousins/mars.layer/src/mars/layer/README.txt	2007-07-13 09:01:50 UTC (rev 77808)
@@ -2,12 +2,34 @@
 Mars Layer
 ==========
 
-Martian is a library that allows the embedding of configuration
-information in Python code. Martian can then grok the system and
-do the appropriate configuration registrations.
+Introduction
+------------
 
-This package uses martian to define layers and skins.
+`Grok`_ is a project which seeks to provide convention over configuration.
 
+``Martian`` grew from `Grok`_:
+
+ Martian provides a framework that allows configuration to be expressed
+ in declarative Python code. These declarations can often be deduced
+ from the structure of the code itself. The idea is to make these
+ declarations so minimal and easy to read that even extensive
+ configuration does not overly burden the programmers working with the
+ code. Configuration actions are executed during a separate phase
+ ("grok time"), not at import time, which makes it easier to reason
+ about and easier to test.
+
+ The ``martian`` package is a spin-off from the `Grok`_ project, in the
+ context of which this codebase was first developed. While Grok uses
+ it, the code is completely independent of Grok.
+
+.. _Grok: http://grok.zope.org/
+
+Mars Layer
+----------
+
+The mars.layer package provides the means of creating and configuring ``layers``
+and ``skins`` for an application using Zope3.
+
 The base layers available are:
 
 * mars.layer.IMinimalLayer
@@ -40,12 +62,17 @@
 
 Skin is available as http://localhost/++skin++myskin
 
-Directives
-----------
+Directives specific to this package
+-----------------------------------
 
-Please see ``directive.txt``.
+* mars.layer.layer(class_or_interface):
+  The layer for which the view should be available.
+  Default: zope.publisher.browser.interfaces.IBrowserRequest
 
-Tests
------
+Relevant grok directives
+------------------------
 
-See test directory.
+* grok.name(name):
+  The name for which the skin is registered.
+  Default: factory.__name__.lower()
+