Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Moved instructions from build.xml to README.txt and polished them.

  • Loading branch information...
commit d27134e8aed632dab3f31d57db9bcf6c66dabd1f 1 parent 6fe0023
jhunter authored
Showing with 82 additions and 74 deletions.
  1. +79 −0 core/README.txt
  2. +3 −74 core/build.xml
View
79 core/README.txt
@@ -0,0 +1,79 @@
+Introduction
+============
+
+See the web site http://jdom.org
+
+
+Installing the build tools
+==========================
+
+The JDOM build system is based on Jakarta Ant, which is a Java building tool
+originally developed for the Jakarta Tomcat project but now used in many other
+Apache projects and extended by many developers.
+
+Ant is a little but very handy tool that uses a build file written in XML
+(build.xml) as building instructions. For more information refer to
+"http://jakarta.apache.org/ant/".
+
+The only thing that you have to make sure of is that the "JAVA_HOME"
+environment property is set to match the top level directory containing the
+JVM you want to use. For example:
+
+C:\> set JAVA_HOME=C:\jdk1.2.2
+
+or on Unix:
+
+% setenv JAVA_HOME /usr/local/java
+ (csh)
+> JAVA_HOME=/usr/java; export JAVA_HOME
+ (ksh, bash)
+
+That's it!
+
+Building instructions
+=====================
+
+Ok, let's build the code. First, make sure your current working directory is
+where the build.xml file is located. Then type
+
+ ./build.sh (unix)
+ .\build.bat (win32)
+
+if everything is right and all the required packages are visible, this action
+will generate a file called "jdom.jar" in the "./build" directory. Note, that
+if you do further development, compilation time is reduced since Ant is able
+to detect which files have changed an to recompile them at need.
+
+If something went wrong, go to the FAQ section below.
+
+Also, you'll note that reusing a single JVM instance for each task, increases
+tremendously the performance of the whole build system, compared to other
+tools (i.e. make or shell scripts) where a new JVM is started for each task.
+
+
+Build targets
+=============
+
+The build system is not only responsible for compiling JDOM into a jar file,
+but is also responsible for creating the HTML documentation in the form of
+javadocs.
+
+These are the meaningful targets for this build file:
+
+ - package [default] -> creates ./build/jdom.jar
+ - compile -> compiles the source code
+ - samples -> compiles example code
+ - javadoc -> generates the API documentation in ./build/javadocs
+ - clean -> restores the distribution to its original and clean state
+
+For example, to build the samples, type
+
+build samples
+(Windows)
+
+build.sh samples
+(Unix)
+
+To learn the details of what each target does, read the build.xml file. It is
+quite understandable.
+
View
77 core/build.xml
@@ -1,77 +1,6 @@
-<!-- ===========================================================================
+<!--
-
- JDOM Build File
- ===============
-
-
-Introduction
-============
-
-To Be Written
-
-
-Installing the build tools
-==========================
-
-The JDOM build system is based on Jakarta Ant, which is a Java building tool
-originally developed for the Jakarta Tomcat project but now used in many other
-Apache projects and extended by many developers.
-
-Ant is a little but very handy tool that uses a build file written in XML
-(this file) as building instructions. For more information refer to
-"http://jakarta.apache.org/ant/".
-
-The only thing that you have to make sure of is that the "JAVA_HOME" environment
-property is set to match the top level directory containing the JVM you want
-to use. For example:
-
-C:\> set JAVA_HOME=C:\jdk1.2.2
-
-or on Unix:
-
-% setenv JAVA_HOME /usr/local/java
- (csh)
-> JAVA_HOME=/usr/java; export JAVA_HOME
- (ksh, bash)
-
-That's it!
-
-Building instructions
-=====================
-
-Ok, let's build the code. First, make sure your current working directory is
-where this very file is located. Then type
-
- ./build.sh (unix)
- .\build.bat (win32)
-
-if everything is right and all the required packages are visible, this action
-will generate a file called "jdom.jar" in the "./build" directory. Note, that
-if you do further development, compilation time is reduced since Ant is able
-to detect which files have changed an to recompile them at need.
-
-If something went wrong, go to the FAQ section below.
-
-Also, you'll note that reusing a single JVM instance for each task, increases
-tremendously the performance of the whole build system, compared to other
-tools (i.e. make or shell scripts) where a new JVM is started for each task.
-
-
-Build targets
-=============
-
-The build system is not only responsible of compiling JDOM into a jar file,
-but is also responsible for creating the HTML documentation in the form of
-javadocs.
-
-These are the meaningful targets for this build file:
-
- - package [default] -> creates ./build/jdom.jar
- - compile -> compiles the source code
- - samples -> compiles example code
- - javadoc -> generates the API documentation in ./build/javadocs
- - clean -> restores the distribution to its original and clean state
+For instructions on how to build JDOM, please view the README.txt file.
-->
@@ -83,7 +12,7 @@ These are the meaningful targets for this build file:
<target name="init">
<tstamp/>
<property name="Name" value="JDOM"/>
- <property name="name" value="jdom-b4"/>
+ <property name="name" value="jdom"/>
<property name="version" value="1.0beta4"/>
<property name="year" value="2000"/>
Please sign in to comment.
Something went wrong with that request. Please try again.