From 44ab0fb8fa756cea78fb3d5b0a7cd15307380bfe Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Fri, 17 Jan 2003 20:28:53 +0000 Subject: [PATCH] Initial check-in. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@1810 b35dd754-fafc-0310-a699-88a17e54d16e --- build/README.html | 314 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 314 insertions(+) create mode 100644 build/README.html diff --git a/build/README.html b/build/README.html new file mode 100644 index 000000000..889310650 --- /dev/null +++ b/build/README.html @@ -0,0 +1,314 @@ + + + + + Smack Source Distribution + + + + + + +Smack Source Distribution
+
+

+ +This document provides detailed information for developers that wish to +compile and make changes to the Smack source code. + + +

For additional developer resources, please visit: + +http://www.jivesoftware.com/xmpp/smack/. The Smack build process is based on Ant. Visit the +Ant website +for more information. There is no need to download and install Ant - a version of it is included +in this distribution. +

+This documentation is divided into two sections: +

    +
  1. Setup -- how to setup your environment for Smack development. +
  2. Build tasks -- tasks that can be performed using the build program. +
+ +

1. Setup Your Environment

+ +Getting your machine ready for Smack development requires a few steps. Wherever +possible, instructions are provided for both Unix/Linux and Windows users. +

+Configure Java +

+ +

Test the Build Script

+

 + +

Finished!

+

+ +

+ +

2. Build Tasks

+ + The list of build tasks is below. All build commands should be + run from the "build" directory of your Smack distribution. + +

+ + For a list of the commands and a brief description from the command line, type + ant -projecthelp. For more complete help, read the documentation below. + +

+ + To execute a build task, type ant [options] targetname where "targetname" is + one of the targets listed below: + +

+

+Each task is documented with a syntax guide and description. Optional paramaters +for each task are enclosed with braces. + + +

Default +

 + + +

compile +

 + + + +

jar +

 + + + +

javadoc +

 + + +

clean +

 + + +