dlr 2002/07/08 01:25:33 Modified: . README.txt Removed: . TURBINE_3_0_README.txt Log: Updated README, merging relevant portions of TURBINE_3_0_README.txt with README.txt. Revision Changes Path 1.3 +24 -21 jakarta-turbine-3/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/jakarta-turbine-3/README.txt,v retrieving revision 1.2 retrieving revision 1.3 diff -u -u -r1.2 -r1.3 --- README.txt 27 Sep 2001 17:57:08 -0000 1.2 +++ README.txt 8 Jul 2002 08:25:33 -0000 1.3 @@ -3,31 +3,34 @@ Turbine Top Level README -------------------------------------------------------------------------- +Welcome to Turbine. -Welcome to Turbine. For more information about Turbine, please look -at the HTML documentation in the docs/ directory. +Using Turbine 3.0 is done _entirely_ at your own risk at this point; +the Turbine 3.0 API has not yet been solidified. We recommend that +people stay with 2.1 until 3.0 is ready. -Here is a description of what each of the top level directories -contains. Please consult the documentation in each of the lower level -directories for information that is specific to their contents. - -bin/ This is a temporary directory for building the project. -build/ This is where the build scripts live. -conf/ This is where the sample configurations live. -docs/ This is where the documentation and database schemas live. +In order to get started using Turbine, you must build it first. +Please refer to the BUILDING.txt file for details on building Turbine. + +For more information about Turbine, please refer to the HTML +documentation in the docs/ directory, or at +<http://jakarta.apache.org/turbine/turbine-3/>. + +The top level directories contain: + +conf/ Various configuration files. +docs/ Generated (xdoc-based) documentation. All of the files in this directory are mirrored onto the live website. -lib/ This is where the additional libraries and .jar - files reside. -src/ This is where all of the source code to Turbine lives. - -In order to get started with Turbine, you must build it first. Please -refer to BUILDING.txt for details on building Turbine. For general -overview of Turbine and more details on how to use the system, please -refer to the documentation in the xdocs/ directory, or at -<http://jakarta.apache.org/turbine/>. +misc/ Miscellaneous files. +notes/ Random musings by Turbine developers. +proposals/ Proposed API changes and implementations. +src/ Source code to Turbine. +target/ A temporary directory for building the project. +xdocs/ XML sources for generated documentation. + -Thanks, +Thanks, -The Turbine Team
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
