X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;ds=sidebyside;f=org.argeo.slc%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fant%2Fpackage.html;fp=org.argeo.slc%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fant%2Fpackage.html;h=9f36fb1bf5373af5bcf0aa4f4c310b853029bf77;hb=1a85bfb58f79c5f85b86f8b77aeed8eb0bbe238e;hp=14a54d1af121a5ce2475a703e7f179607a205537;hpb=a29c28266fef35c1620f6582ec182bad7f7f85ae;p=gpl%2Fargeo-slc.git
diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html b/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
index 14a54d1af..9f36fb1bf 100644
--- a/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
@@ -2,13 +2,37 @@
Bases classes for SLC Ant extensions.
-Usage of SLC Ant extensions
-Add:
-
-<taskdef resource="org/argeo/slc/ant/taskdefs.properties" />
-
-at the beginning of your file.
+Introduction
+SLC Ant allows to integrate Ant and Spring in order to run an
+application based on top of SLC. Sequence of actions are defined in Ant
+files with specific Ant tasks referencing Spring beans implementing the
+SLC interfaces. The properties of these beans can be overridden at
+runtime in the Ant scripts.
+
+SLC Ant also provides a tree-based implementation of the SLC structure
+which allows to uniquely identify and reference the various actions.
+Installation
+The structure will be first defined by the directory tree where the Ant
+files are stored. In order to define the root of this tree, you need to
+place in the root directory an
+SLC Ant root file
+(default name: slcRoot.properties).
+
+In this root file you can define a configuration directory and a work
+directory (default values are provided if they are not explicitly set).
+
+Additional properties can then be defined in files stored under the
+configuration directory.
+
+For details about the configuration and the various properties, please
+refer to {@link org.argeo.slc.ant.SlcAntConfig}.
+
+Running SLC Ant
+SLC Ant can be run either via pure Ant scripts or programmatically using
+{@link org.argeo.slc.ant.AntRegistryUtil}. In both cases, make sure that
+SLC and its dependencies are in the classpath (Spring (always), logging
+system such as log4j, Hibernate, etc.).