seade 2004/08/18 18:12:44
Modified: . Tag: TORQUE_3_1_BRANCH README.txt
Log:
Update README file to reflect reality.
Revision Changes Path
No revision
No revision
1.8.2.1 +35 -12 db-torque/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/db-torque/README.txt,v
retrieving revision 1.8
retrieving revision 1.8.2.1
diff -u -r1.8 -r1.8.2.1
--- README.txt 19 Jun 2003 03:26:35 -0000 1.8
+++ README.txt 19 Aug 2004 01:12:44 -0000 1.8.2.1
@@ -4,21 +4,44 @@
Torque is an Object/Relational persistence layer.
-profile/ RDBMS-specific configuration profiles.
-target/ Temporary directory for building the project.
-examples/ Example XML Torque schemas that are part of the distribution.
-notes/ Misc. notes.
-src/ Location of Java sources and Torque templates.
-xdocs/ Torque documention in Anakia formatted tags.
+Use Torque generator to generate your object model classes and associated SQL.
+
+Use the Torque maven-plugin or Ant to invoke Torque generator.
+
+The Torque runtime provides the necessary libraries to compile and use the
+object model classes produced by Torque generator. It also provides an Ant
+build file for generating Torque.properties - the Torque runtime configuration
+properties file.
+
+database/ <--- Contains database specific property files used
+ during the generating of runtime configuration
+ property files.
+docs/ <--- Contains a copy of the Torque documentation,
+ including the API JavaDocs.
+lib/ <--- Contains the jar files required by the Torque
+ runtime.
+master/build.xml <--- The Ant build file for regenerating Torque.properties.
+master/default.prperties
+ <--- The properties that will be used when regenerating
+ Torque.properties.
+master/Torque.master
+ <--- The unprocessed property file template.
+componentConfiguration.xml
+roleConfiguration.xml
+ <--- These are included to assist with using Torque as
+ component in a container (e.g. one of the Avalon
+ containers).
+LICENSE.txt <--- The License for the Torque runtime.
+README.txt <--- This file.
+Torque.properties <--- A sample generated runtime configuration file - this
+ will be replaced when you regenerate the runtime
+ configuration.
--------------------------------------------------------------------------
B U I L D I N G
--------------------------------------------------------------------------
-You must have ant version 1.5 or newer installed.
-
-Building the decoupled version of Torque from CVS is now very easy. Torque
-has been Maven-enabled. Please refer to the Maven Getting Started document
-for instructions on building. This document is available here:
-http://jakarta.apache.org/turbine/maven/getting-started.html
+Building Torque from CVS is fairly straight forward - follow the links to
+the Developer Guide for further details:
+ http://db.apache.org/torque/
---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org
|