[Checkins] SVN: bluebream/trunk/docs/source/notes.txt better wordings
Baiju M
baiju.m.mail at gmail.com
Sat Jan 9 21:15:34 EST 2010
Log message for revision 107968:
better wordings
Changed:
U bluebream/trunk/docs/source/notes.txt
-=-
Modified: bluebream/trunk/docs/source/notes.txt
===================================================================
--- bluebream/trunk/docs/source/notes.txt 2010-01-10 01:51:22 UTC (rev 107967)
+++ bluebream/trunk/docs/source/notes.txt 2010-01-10 02:15:34 UTC (rev 107968)
@@ -3,7 +3,7 @@
- BlueBream is a "web framework".
-- BlueBream can be called as Bream or BB for short.
+- Shortening BlueBream as Bream or BB is acceptable.
- The only public API exposed by "bluebream - the package"
is an entry point::
@@ -14,13 +14,13 @@
The implementation of "bluebream" template is defined in
"bluebream.template.BlueBream". The template implementation
location could be changed if required later. This leaves us an
- option to change "bluebream" as a namespace package if required.
+ option to change "bluebream" as a namespace package if desired.
- All the framework code will be using "zope" or "zope.app" namespace
- packages. Although "bream" could be considerd as a namespace
+ packages. Although "bream" could be considered as a namespace
package in future.
-- "bluebream" the project consists
+- "bluebream" the project consists of
- documentation
@@ -31,15 +31,15 @@
May be documentation and compatibility test suite could be
separated out to separate locations/packages later.
-- BlueBream 1.0 should provide an upgradation path from Zope 3.4 KGS
+- BlueBream 1.0 should provide an up-gradation path from Zope 3.4 KGS
-- Any "shell command" which developer need to repeat later should not
- be automated by the project template.
+- Any "shell command" need to be repeated should not be automated by
+ the project template.
- Running ``bootstrap.py`` and ``buildout`` inside project should not
- be added to project template creation for the previous reason. A
- suporting reason why it should not be added is to make adding
- sources to version controlling system should not be difficult.
+ be added to project template creation for the previous reason.
+ Another supporting reason is the easiness of adding sources to
+ version controlling system.
Notes for developers
--------------------
@@ -49,8 +49,8 @@
./bin/sphinxbuilder
./bin/buildout setup . upload_sphinx
-Roadmap
--------
+Road map
+--------
- Make the documentation better
More information about the checkins
mailing list