From 42aa622551e45bcc9b814f5d7ca307ec6a377c9f Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@samskivert.com>
Date: Mon, 17 Nov 2008 19:10:33 +0000
Subject: [PATCH] Added README and build target descriptions.

---
 README    | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 build.xml | 21 +++++++++++++--------
 2 files changed, 59 insertions(+), 8 deletions(-)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..21933e8
--- /dev/null
+++ b/README
@@ -0,0 +1,46 @@
+Depot Persistence Library
+-------------------------
+
+Depot is a relational persistence library for Java. It is an ORM library, but
+has aims that are somewhat different from the popular "managed" persistence
+libraries like Hibernate and others.
+
+Website
+-------
+
+See the Depot website for documentation and other info:
+
+  http://code.google.com/p/depot/
+
+Building
+--------
+
+The library is built using ant. It can be found here:
+
+  http://jakarta.apache.org/ant/
+
+Next, ensure that the necessary third party jar files are copied to the lib/
+directory. See etc/libs-incl.xml for the list of those jar files.
+
+Finally invoke 'ant dist' to compile the code and generate a jar file. Invoke
+'ant -p' to see information on other build targets.
+
+Depot also provides .classpath and .project files for Eclipse users which
+require that you set an EXT_LIBS_DIR variable indicating the location of the
+external jar dependencies. The Depot Eclipse project also depends on the
+Eclipse project for the samskivert library. That library can be found at:
+
+  http://code.google.com/p/samskivert/
+
+License and Distribution
+------------------------
+
+Depot is released under the LGPL. This means you are free to use Depot on any
+project, open source or proprietary, but that any modifications made to the
+library must be made available to the maintainers. See COPYING for more
+detailed information.
+
+The most recent version of the Depot source code is available at the website
+listed above.
+
+$Id$
diff --git a/build.xml b/build.xml
index c9cd48d..9d71e93 100644
--- a/build.xml
+++ b/build.xml
@@ -81,7 +81,7 @@
   </target>
 
   <!-- cleans out the intermediate build files -->
-  <target name="clean">
+  <target name="clean" description="Cleans out build results.">
     <delete dir="${classes.dir}"/>
     <delete dir="${deploy.dir}/docs"/>
     <delete dir="${gwtjar.dir}"/>
@@ -89,12 +89,13 @@
   </target>
 
   <!-- wipes the entire build directory clean -->
-  <target name="distclean">
+  <target name="distclean" description="Completely removes build result directory.">
     <delete dir="${deploy.dir}"/>
   </target>
 
   <!-- build the java class files -->
-  <target name="compile" depends="prepare,compute-builds">
+  <target name="compile" depends="prepare,compute-builds"
+          description="Compiles the code.">
     <javac srcdir="${src.dir}" destdir="${classes.dir}" includeAntRuntime="false"
            debug="on" optimize="${build.optimize}" source="1.5" target="1.5" encoding="utf-8">
       <classpath refid="classpath"/>
@@ -107,7 +108,8 @@
   </target>
 
   <!-- build the javadoc documentation -->
-  <target name="javadoc" depends="prepare,compute-builds">
+  <target name="javadoc" depends="prepare,compute-builds"
+          description="Generates javadoc documentation.">
     <javadoc windowtitle="${lib.name} API" doctitle="${lib.name} API"
              overview="${src.dir}/${doc.overview}" destdir="${javadoc.dir}"
              additionalparam="-breakiterator"
@@ -124,10 +126,11 @@
   </target>
 
   <!-- a target for rebuilding everything -->
-  <target name="all" depends="clean,prepare,compile,javadoc,dist"/>
+  <target name="all" depends="clean,prepare,compile,javadoc,dist"
+          description="Cleans and rebuilds everything including documentation."/>
 
   <!-- runs our unit tests -->
-  <target name="tests" depends="prepare,compile" description="Runs unit tests.">
+  <target name="tests" depends="prepare,compile" description="Runs the unit tests.">
     <taskdef name="unit" classpathref="classpath"
       classname="org.apache.tools.ant.taskdefs.optional.junit.JUnitTask"/>
     <unit printsummary="off" haltonfailure="yes" fork="${junit.fork}">
@@ -149,7 +152,8 @@
   </target>
 
   <!-- builds our distribution jar file -->
-  <target name="dist" depends="prepare,compile">
+  <target name="dist" depends="prepare,compile"
+          description="Compiles the code and builds our jar file.">
     <jar destfile="${deploy.dir}/${lib.name}.jar" basedir="${classes.dir}">
       <exclude name="**/tests/**"/>
     </jar>
@@ -164,7 +168,8 @@
   </target>
 
   <!-- builds a snapshot zip file -->
-  <target name="snapshot" depends="dist">
+  <target name="snapshot" depends="dist"
+          description="Generates a snapshot zip containing the Depot jar file and its dependencies.">
     <tstamp><format property="date" pattern="yyyyMMdd" /></tstamp>
     <mkdir dir="${deploy.dir}/depot-${date}"/>
     <copy todir="${deploy.dir}/depot-${date}">