svn commit: r291281 - in /cocoon/whiteboard/example-apps/bricks-cms: ./ README.TXT STATUS.TXT user.properties

[bd...@apache.org]

Author: bdelacretaz
Date: Sat Sep 24 04:42:27 2005
New Revision: 291281

URL: http://svn.apache.org/viewcvs?rev=291281&view=rev
Log:
README.TXT written

Added:
    cocoon/whiteboard/example-apps/bricks-cms/STATUS.TXT
Modified:
    cocoon/whiteboard/example-apps/bricks-cms/   (props changed)
    cocoon/whiteboard/example-apps/bricks-cms/README.TXT   (contents, props changed)
    cocoon/whiteboard/example-apps/bricks-cms/user.properties

Propchange: cocoon/whiteboard/example-apps/bricks-cms/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Sat Sep 24 04:42:27 2005
@@ -1,3 +1,4 @@
 build
 .classpath
 .project
+local-user.properties

Modified: cocoon/whiteboard/example-apps/bricks-cms/README.TXT
URL: http://svn.apache.org/viewcvs/cocoon/whiteboard/example-apps/bricks-cms/README.TXT?rev=291281&r1=291280&r2=291281&view=diff
==============================================================================
--- cocoon/whiteboard/example-apps/bricks-cms/README.TXT (original)
+++ cocoon/whiteboard/example-apps/bricks-cms/README.TXT Sat Sep 24 04:42:27 2005
@@ -1,24 +1,87 @@
 ===========================================================================
-TODO - describe the bricks-cms app, how to compile and start it
+README.TXT for the bricks-cms app: how to configure, build and run it
 $Id$
 ===========================================================================
 
 This directory contains the source code of the bricks-cms application,
 that will be presented at the GetTogether 2005.
 
-The first commit is only a small skeleton, does nothing useful.
+See the STATUS.TXT for information about what to expect from the app.
 
-To build:
-    Read user.properties and adjust settings by creating a
-    local.user.properties if needed.
 
-    Use ant 1.6.1 or later (from Cocoon?)
+POOR WINDOWS USERS
+Nothing against Windows, but I don't have a Windows setup handy to test
+the app at this time.
 
-    JAVA_HOME must be set
+If someone could try the instructions below under Windows and update
+this file or send patches, it'd be great! 
 
-    ant cocoon:get
-    ant run
+The instructions below have been tested under macosx 10.3.8, and should
+work under Linux as well.
 
-Tips and tricks:
-    Use rsync -r src/cocoon/webapp/* build/cocoon/webapp/ to update
-    the running webapp without having to restart it.
\ No newline at end of file
+
+REQUIREMENTS
+You'll need:
+ - JDK 1.4.x (tested with 1.4.2_05 on macosx).
+ - ant 1.6.1, see below.
+ - The bricks-cms code, obviously
+
+
+CONFIGURING
+Read user.properties and adjust settings by creating a local.user.properties 
+if needed. All configurable properties are explained there.
+
+If you modify the application and need to activate more Cocoon blocks, see
+the src/cocoon/config/cocoon.build.properties file, which has a slightly 
+different syntax than the stock Cocoon build.properties file.
+
+
+BUILDING
+The build needs ant 1.6.1 or later, which must be correctly setup
+in your environment. If you don't know how to do this, it might be good
+to understand how environment variables work before going further, to
+avoid frustration.
+
+To use the version of ant which is included in the Cocoon repository,
+the example below should work if you have checked out Cocoon and the 
+bricks-cms example app with the same directory layout as in the SVN
+repository:
+
+  export ANT_HOME=../../../branches/BRANCH_2_1_X/tools/
+  export PATH=$ANT_HOME/bin:$PATH
+
+If you have the correct version of ant in your environment, typing "ant"
+in the bricks-cms directory should say:
+
+  Buildfile: build.xml
+
+  explain:
+       [echo] See README.TXT for how to setup and use this module
+
+  BUILD SUCCESSFUL
+  
+If this works, type "ant run" and follow the on-screen instructions.
+
+
+RUNNING
+If the above ant test works, you'll need to run "ant cocoon:get" once
+to compile Cocoon and put the result in the build/cocoon directory.
+
+This requires the cocoon.distro.home property to be set correctly
+in the (local.)user.properties file.
+
+Then, "ant run" should start the application, which will be made
+available at http://localhost:8888.
+
+The application is started by the standard "cocoon.sh" script, so you
+can use the environment variables that this script understands to
+customize how the app is run (port, etc.).
+
+
+TIPS AND TRICKS:
+Use rsync -r src/cocoon/webapp/* build/cocoon/webapp/ to update the 
+running webapp without having to restart it. 
+
+This allows you to activate any changes made to non-java code 
+(sitemaps, XSLT, etc) in the src tree, by copying the changed files 
+to the running webapp.
\ No newline at end of file

Propchange: cocoon/whiteboard/example-apps/bricks-cms/README.TXT
------------------------------------------------------------------------------
    svn:keywords = Id

Added: cocoon/whiteboard/example-apps/bricks-cms/STATUS.TXT
URL: http://svn.apache.org/viewcvs/cocoon/whiteboard/example-apps/bricks-cms/STATUS.TXT?rev=291281&view=auto
==============================================================================
--- cocoon/whiteboard/example-apps/bricks-cms/STATUS.TXT (added)
+++ cocoon/whiteboard/example-apps/bricks-cms/STATUS.TXT Sat Sep 24 04:42:27 2005
@@ -0,0 +1,7 @@
+===========================================================================
+STATUS.TXT for the bricks-cms app: what to expect from this code.
+$Id$
+===========================================================================
+
+The current revision does nothing useful, only the build system and app
+skeleton are in place, stay tuned...
\ No newline at end of file

Modified: cocoon/whiteboard/example-apps/bricks-cms/user.properties
URL: http://svn.apache.org/viewcvs/cocoon/whiteboard/example-apps/bricks-cms/user.properties?rev=291281&r1=291280&r2=291281&view=diff
==============================================================================
--- cocoon/whiteboard/example-apps/bricks-cms/user.properties (original)
+++ cocoon/whiteboard/example-apps/bricks-cms/user.properties Sat Sep 24 04:42:27 2005
@@ -15,10 +15,12 @@
 # $Id: user.properties,v 1.2 2005/07/25 14:26:20 bdelacretaz Exp $
 # --------------------------------------------------------------------------
 
-# Select Cocoon distribution to use
-# To customize the Cocoon build see src/cocoon/config/cocoon.build.properties
+# Select Cocoon distribution to use - this must point to the directory
+# that contains the Cocoon build.sh and cocoon.sh scripts.
 # For example:
 #   cocoon.distro.home=/software/cocoon/2.1.7
+#
+# To customize the Cocoon build see src/cocoon/config/cocoon.build.properties
 # --------------------------------------------------------------------------
 cocoon.distro.home=../../../branches/BRANCH_2_1_X