Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update Package to contain LICENSE.txt and README.txt

Convert them to 'DOS' format end-of-line.
Update copyright to 2012
Update README.txt content
  • Loading branch information...
commit 6ebedbf1ab092b5e3024c365fb4473d20c662f77 1 parent 45a5810
@rolfl rolfl authored
Showing with 174 additions and 156 deletions.
  1. +54 −54 LICENSE.txt
  2. +119 −102 README.txt
  3. +1 −0  build.xml
View
108 LICENSE.txt
@@ -1,54 +1,54 @@
-/*--
-
- Copyright (C) 2000-2011 Jason Hunter & Brett McLaughlin.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions, and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions, and the disclaimer that follows
- these conditions in the documentation and/or other materials
- provided with the distribution.
-
- 3. The name "JDOM" must not be used to endorse or promote products
- derived from this software without prior written permission. For
- written permission, please contact <request_AT_jdom_DOT_org>.
-
- 4. Products derived from this software may not be called "JDOM", nor
- may "JDOM" appear in their name, without prior written permission
- from the JDOM Project Management <request_AT_jdom_DOT_org>.
-
- In addition, we request (but do not require) that you include in the
- end-user documentation provided with the redistribution and/or in the
- software itself an acknowledgement equivalent to the following:
- "This product includes software developed by the
- JDOM Project (http://www.jdom.org/)."
- Alternatively, the acknowledgment may be graphical using the logos
- available at http://www.jdom.org/images/logos.
-
- THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
- CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- SUCH DAMAGE.
-
- This software consists of voluntary contributions made by many
- individuals on behalf of the JDOM Project and was originally
- created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
- Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
- on the JDOM Project, please see <http://www.jdom.org/>.
-
- */
-
+/*--
+
+ Copyright (C) 2000-2012 Jason Hunter & Brett McLaughlin.
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions, and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions, and the disclaimer that follows
+ these conditions in the documentation and/or other materials
+ provided with the distribution.
+
+ 3. The name "JDOM" must not be used to endorse or promote products
+ derived from this software without prior written permission. For
+ written permission, please contact <request_AT_jdom_DOT_org>.
+
+ 4. Products derived from this software may not be called "JDOM", nor
+ may "JDOM" appear in their name, without prior written permission
+ from the JDOM Project Management <request_AT_jdom_DOT_org>.
+
+ In addition, we request (but do not require) that you include in the
+ end-user documentation provided with the redistribution and/or in the
+ software itself an acknowledgement equivalent to the following:
+ "This product includes software developed by the
+ JDOM Project (http://www.jdom.org/)."
+ Alternatively, the acknowledgment may be graphical using the logos
+ available at http://www.jdom.org/images/logos.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGE.
+
+ This software consists of voluntary contributions made by many
+ individuals on behalf of the JDOM Project and was originally
+ created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
+ Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
+ on the JDOM Project, please see <http://www.jdom.org/>.
+
+ */
+
View
221 README.txt
@@ -1,102 +1,119 @@
-Introduction to the JDOM project
-================================
-
-Please see the JDOM web site at http://jdom.org/
-and GitHub repository at https://github.com/hunterhacker/jdom/
-
-Quick-Start for JDOM2
-=====================
-See http://hunterhacker.github.com/jdom/jdom2/ for learning about JDOM2
-
-
-How to use JDOM
-===============
-
-Please see the web site http://jdom.org/downloads/docs.html. It has links to
-numerous articles and books covering JDOM.
-
-
-Installing the build tools
-==========================
-
-The JDOM build system is based on Apache Ant. 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://ant.apache.org".
-
-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.6
-
-or on Mac:
-
-% setenv JAVA_HOME /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home
- (csh)
-> JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home; export JAVA_HOME
- (ksh, bash)
-
-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 run "ant".
-
-If everything is right and all the required packages are visible, this action
-will generate a file called "jdom2.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 and recompile them as needed.
-
-If something went wrong, go to the FAQ at http://www.jdom.org/docs/faq.html.
-
-
-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] -> generates ./build/jdom2.jar and other supporting files
- - compile -> compiles the source code
- - javadoc -> generates the API documentation in ./build/javadocs
- - junit -> runs the JUnit tests
- - coverage -> generates test coverage metrics
- - eclipse -> generates an Eclipse project (source folders, jars, etc)
- - clean -> restores the distribution to its original and clean state
-
-To learn the details of what each target does, read the build.xml file. It is
-quite understandable.
-
-
-Bug Reports
-===========
-
-Bug reports go to the jdom-interest list at jdom.org. But *BEFORE YOU POST*
-make sure you've tested against the LATEST code available from GitHub (or the
-daily snapshot). Odds are good your bug has already been fixed. If it hasn't
-been fixed in the latest version, then when posting *BE SURE TO SAY* which
-code version you tested against. For example, "GitHub from October 3rd". Also
-be sure to include enough information to reproduce the bug and full exception
-stack traces. You might also want to read the FAQ at http://jdom.org to find
-out if your problem is not really a bug and just a common misunderstanding
-about how XML or JDOM works.
-
-
-Searching for Information
-=========================
-
-The JDOM mailing lists are archived and easily searched at
-http://jdom.markmail.org.
+Introduction to the JDOM project
+================================
+
+Please see the JDOM web site at http://jdom.org/
+and GitHub repository at https://github.com/hunterhacker/jdom/
+
+Quick-Start for JDOM
+=====================
+See the github wiki for a Primer on using JDOM:
+https://github.com/hunterhacker/jdom/wiki/JDOM2-A-Primer
+
+Also see the web site http://jdom.org/downloads/docs.html. It has links to
+numerous articles and books covering JDOM.
+
+
+Installing the build tools
+==========================
+
+The JDOM build system is based on Apache Ant. 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://ant.apache.org".
+
+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.6
+
+or on Mac:
+
+% setenv JAVA_HOME /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home
+ (csh)
+> JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home; export JAVA_HOME
+ (ksh, bash)
+
+or on Unix:
+
+% setenv JAVA_HOME /usr/local/java
+ (csh)
+> JAVA_HOME=/usr/java; export JAVA_HOME
+ (ksh, bash)
+
+That's it!
+
+
+Building instructions
+=====================
+
+If you do not have the full source code it can be cloned from GitHub. The JDOM
+project at https://github.com/hunterhacker/jdom has the instructions and source
+URL to make the git clone easy.
+
+You will need to have Apache Ant 1.8.2 or later, and you will need Java JDK 1.6
+or later.
+
+Ok, let's build the code. First, make sure your current working directory is
+where the build.xml file is located. Then run "ant".
+
+If everything is right and all the required packages are visible, this action
+will generate a file called "jdom-2.x-20yy.mm.dd.HH.MM.zip" in the
+"./build/package" directory. This is the same 'zip' file that is distributed
+as the official JDOM distribution.
+
+The name of the zip file (and the jar names inside the zip) is controlled by
+the two ant properties 'name' and 'version'. The package is called
+"${name}-${version}.zip". The 'official' JDOM Build process is done by
+creating a file 'build.properties' in the 'top' folder of the JDOM code, and
+it contains the single line (or whatever the appropriate version is):
+
+version=2.0.0
+
+If your favourite Java IDE happens to be Eclipse, you can run the 'eclipse' ant
+target, and that will configure your Eclipse project to have all the right
+'source' folders, and 'Referenced Libraries'. After running the 'ant eclipse'
+target, you should refresh your Eclipse project, and you should have a project
+with no errors or warnings.
+
+
+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] -> generates ./build/package/jdom*.zip
+ - compile -> compiles the source code
+ - javadoc -> generates the API documentation in ./build/javadocs
+ - junit -> runs the JUnit tests
+ - coverage -> generates test coverage metrics
+ - eclipse -> generates an Eclipse project (source folders, jars, etc)
+ - clean -> restores the distribution to its original and clean state
+ - maven -> generates the package, and makes a 'bundle' for maven-central
+
+To learn the details of what each target does, read the build.xml file. It is
+quite understandable.
+
+
+Bug Reports
+===========
+
+Bug reports go to the jdom-interest list at jdom.org. But *BEFORE YOU POST*
+make sure you've tested against the LATEST code available from GitHub (or the
+daily snapshot). Odds are good your bug has already been fixed. If it hasn't
+been fixed in the latest version, then when posting *BE SURE TO SAY* which
+code version you tested against. For example, "GitHub from October 3rd". Also
+be sure to include enough information to reproduce the bug and full exception
+stack traces. You might also want to read the FAQ at http://jdom.org to find
+out if your problem is not really a bug and just a common misunderstanding
+about how XML or JDOM works.
+
+
+Searching for Information
+=========================
+
+The JDOM mailing lists are archived and easily searched at
+http://jdom.markmail.org.
View
1  build.xml
@@ -331,6 +331,7 @@ For instructions on how to build JDOM, please view the README.txt file.
<zip destfile="${package}/${jarbase}.zip">
<fileset dir="${package}" includes="${jarbase}*.jar" />
<fileset dir="${basedir}" includes="lib/xerces* lib/jaxen* lib/xml*" />
+ <fileset dir="${basedir}" includes="LICENSE.txt README.txt" />
</zip>
</target>
Please sign in to comment.
Something went wrong with that request. Please try again.