antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 5 Projects Releases 5 Activity Actions

Update and rename README.txt to README.md

Browse source
This commit is contained in:
Tobi Schäfer 2015-04-08 19:00:36 +02:00
parent af2c37bda6
commit 60b31e6133
2 changed files with 38 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
build/README.md Normal file
View file

@ -0,0 +1,38 @@
_This is the README file for the Helma build files as part of the Helma Object Publisher._
## Prerequisites
The Helma build script is using Apache Ant.
For more information about Ant, see <http://ant.apache.org/>.
## Building
The build system is started by invoking the shell script appropriate to your
platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows
systems. You probably need to modify the script and set the `JAVA_HOME` to fit your system.
The generic syntax is
ant target
The parameter `target` specifies one of the build targets listed below.
## Build Targets
**compile**
Compiles the source files into the `./classes` directory (which will be created if necessary).
**jar**
Creates a helma.jar file (snapshot) in the lib directory. The file is named `helma-yyyymmdd.jar`.
**javadocs**
Creates the JavaDoc API documentation.
**package**
Creates the full Helma distribution packages and places them in the dist directory.
**app [name]**
Gets an application from the source code repository, zips / targzs it and places the files in the dist directory.
**module [name]**
Gets a module from the source code repository, zips it and places the file in the dist directory.

52
build/README.txt
View file

@ -1,52 +0,0 @@
This is the README file for the Helma build files as part of the Helma Object Publisher.
PREREQUISITES
=============
The Helma build script is uses Apache Ant.
For more information about Ant, see <http://ant.apache.org/>.
For checking out the source files from Helma's CVS you also need a CVS client.
More information about CVS at <http://www.cvshome.org/>.
STARTING BUILD
==============
The build system is started by invoking the shell script appropriate to your
platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows
systems. You need to modify the script and set the JAVA_HOME to fit your system.
The generic syntax is
ant target
The parameter "target" specifies one of the build targets listed below.
BUILD TARGETS
=============
compile
Compiles the source files contained in the work/checkout/hop/ directory into the work/classes/ directory (which will be created if necessary).
jar
Creates a helma.jar file (snapshot) in the lib-directory. The file is named helma-yyyymmdd.jar.
javadocs
Creates the javadoc API documentation.
package
Creates the full helma distribution packages and places them in the dist directory.
app [name]
Gets an application from the cvs, zips/targzs it and places the files in the dist directory.
module [name]
Gets a module from the cvs, zips it and places the file in the dist directory.
--