Changeset 222 for cleverbox/trunk/docs/README

Timestamp:

02/13/08 20:33:03 (4 years ago)

Author:

trivoallan

Message:

cleverbox :

• documentation cleanup
• started implementation of parameter checking method

Files:

• cleverbox/trunk/docs/README (modified) (1 diff)

cleverbox/trunk/docs/README

@@ -1 @@
-The Cleverbox sits on top of [http://trac.edgewall.org Trac] and [http://subversion.tigris.org Subversion].
-It provides an interactive shell for deploying and maintaining instances of both projects.
+'''Please note : this version of the cleverbox is highly instable and should not be used in production. Latest stable version is cleverbox-0.4.'''
 
-== Features ==
+== What is it ? ==
 
- * Configuration profiles :
-   * Apache configuration templates
-   * `trac.ini` configuration template
-   * Default permissions
- * Easy to setup
- * Easy to use
- * Upgrade scripts provided with each new release (as of 0.4)
+The cleverbox provides an interactive command line shell dedicated to the deployment and maintenance of trac and subversion instances.
 
-== Non-goals ==
+It can handle multiple configuration profiles, enabling the deployment of differently flavored type of project (trac configuration and permissions, apache configuration templates, etc).
 
-This project does not have these features and will not get them anytime :
-
- * A web frontend
- * Full fledged plugins support
- * Multi-project Trac
- 
-Why ? Because this script is meant to stay simple. If you want that you'd better checkout [http://www.kforgeproject.com/ KForge] which has the 
-same feature set as the Cleverbox + a [http://www.djangoproject.com django]-based web frontend and very nice plugins integration (for providing new services). 
-Caveats : difficult to install and a bit instable at the moment (but i'm confident it will get better with 0.14 & following releases). 
+Project's main objective is to make your life as simple as possible. Thus, it comes with easy installation, easy upgrades and a comprehensive documentation.
 
 == License ==