[Checkins] SVN: z3c.preference/branches/icemac-dev/ Documented preconditions to use this package

[Michael Howitz]

Log message for revision 114809:
  Documented preconditions to use this package
  

Changed:
  U   z3c.preference/branches/icemac-dev/CHANGES.txt
  U   z3c.preference/branches/icemac-dev/src/z3c/preference/README.txt

-=-
Modified: z3c.preference/branches/icemac-dev/CHANGES.txt
===================================================================
--- z3c.preference/branches/icemac-dev/CHANGES.txt	2010-07-17 07:26:57 UTC (rev 114808)
+++ z3c.preference/branches/icemac-dev/CHANGES.txt	2010-07-17 19:01:09 UTC (rev 114809)
@@ -6,9 +6,9 @@
 0.1.1 (unreleased)
 ==================
 
-- Nothing changed yet.
+- Documented preconditions to use this package, see `Using
+  z3c.preference`_.
 
-
 0.1.0 (2010-07-10)
 ==================
 

Modified: z3c.preference/branches/icemac-dev/src/z3c/preference/README.txt
===================================================================
--- z3c.preference/branches/icemac-dev/src/z3c/preference/README.txt	2010-07-17 07:26:57 UTC (rev 114808)
+++ z3c.preference/branches/icemac-dev/src/z3c/preference/README.txt	2010-07-17 19:01:09 UTC (rev 114809)
@@ -2,13 +2,29 @@
 z3c.preference
 ==============
 
-``z3c.preference`` renders forms for the preferences defined using
-``zope.preference``.
+``z3c.preference`` renders forms in the browser for the preference
+sets which were defined using zope.preference_.
 
+.. _zope.preference: http://pypi.python.org/pypi/zope.preference
 
-Set up
-======
+Using z3c.preference
+====================
 
+There are some preconditions to use `z3c.preference`:
+
+* The views for the ``++preferences++`` namespace are registered for
+  the layer ``z3c.preference.interfaces.IPreferenceLayer``. So you
+  have to add this interface to the browser layer of your application.
+
+* Only users having the permission ``z3c.preference.EditPreference``
+  are allowed to access the the preference views. So you have to add this
+  permission to the users resp. roles which should be able to access
+  the preferences views.
+
+
+Set up for tests
+================
+
 At first we have to define a preference interface:
 
   >>> import zope.interface