From 2bd9bb3daa0ac7280b876314e19bdcb2f17c9a43 Mon Sep 17 00:00:00 2001 From: crossley Date: Sun, 7 Sep 2003 13:16:53 +0000 Subject: [PATCH] Start to explain the build system. git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226114 13f79535-47bb-0310-9956-ffa450edef68 --- readme-build.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 readme-build.txt diff --git a/readme-build.txt b/readme-build.txt new file mode 100644 index 0000000..df7d388 --- /dev/null +++ b/readme-build.txt @@ -0,0 +1,32 @@ +------------------------------------------------------------------------ +Describes how to build xml-commons distributions and documentation. +------------------------------------------------------------------------ + +* The xml-commons distribution contains various utilities. Each utility +is also available as a separate distribution (currently only resolver). + +* The top-level build.xml controls everything. It calls the separate +build files for each sub-project. The sub-project builds can also be +called direectly + +* All documentation is built by Apache Forrest (so you need that locally +installed). See http://xml.apache.org/commons/howto-forrest.html +The website update cronjob happens via user dims at 01:00 and 13:00 GMT. + +------------------------------------------------------------------------ +cd xml-commons +ant -projecthelp +... No point repeating the options here, but one hint: +site, validate, war, and webapp targets are part of Forrest. + +ant all +- Builds the documentation, builds each sub-project, and packs the +distribution. + +------------------------------------------------------------------------ +cd xml-commons/java +ant -buildfile resolver.xml dist +... Builds separate resolver distribution and copies over some relevant +Forrest-built docs. + +------------------------------------------------------------------------