Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 103 lines (70 sloc) 3.405 kb
286a23e Tweaking up.
jhunter authored
1 Introduction to the JDOM project
2 ================================
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
3
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
4 Please see the JDOM web site at http://jdom.org/
5 and GitHub repository at https://github.com/hunterhacker/jdom/
286a23e Tweaking up.
jhunter authored
6
44cba0d @rolfl Add Reference to JDOM2 page.
rolfl authored
7 Quick-Start for JDOM2
8 =====================
9 See http://hunterhacker.github.com/jdom/jdom2/ for learning about JDOM2
10
286a23e Tweaking up.
jhunter authored
11
12 How to use JDOM
13 ===============
14
15 Please see the web site http://jdom.org/downloads/docs.html. It has links to
16 numerous articles and books covering JDOM.
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
17
18
19 Installing the build tools
20 ==========================
21
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
22 The JDOM build system is based on Apache Ant. Ant is a little but very
23 handy tool that uses a build file written in XML (build.xml) as building
24 instructions. For more information refer to "http://ant.apache.org".
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
25
26 The only thing that you have to make sure of is that the "JAVA_HOME"
27 environment property is set to match the top level directory containing the
28 JVM you want to use. For example:
29
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
30 C:\> set JAVA_HOME=C:\jdk1.6
31
32 or on Mac:
33
34 % setenv JAVA_HOME /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home
35 (csh)
36 > JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home; export JAVA_HOME
37 (ksh, bash)
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
38
39 or on Unix:
40
41 % setenv JAVA_HOME /usr/local/java
42 (csh)
43 > JAVA_HOME=/usr/java; export JAVA_HOME
44 (ksh, bash)
45
46 That's it!
47
2d4f269 Added section on how to do bug reports.
jhunter authored
48
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
49 Building instructions
50 =====================
51
52 Ok, let's build the code. First, make sure your current working directory is
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
53 where the build.xml file is located. Then run "ant".
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
54
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
55 If everything is right and all the required packages are visible, this action
56 will generate a file called "jdom2.jar" in the "./build" directory. Note, that
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
57 if you do further development, compilation time is reduced since Ant is able
fd59de6 Removing support for JDK 1.1.
jhunter authored
58 to detect which files have changed and recompile them as needed.
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
59
eb83f0f Adding a pointer to the FAQ.
jhunter authored
60 If something went wrong, go to the FAQ at http://www.jdom.org/docs/faq.html.
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
61
62
63 Build targets
64 =============
65
66 The build system is not only responsible for compiling JDOM into a jar file,
67 but is also responsible for creating the HTML documentation in the form of
68 javadocs.
69
70 These are the meaningful targets for this build file:
71
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
72 - package [default] -> generates ./build/jdom2.jar and other supporting files
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
73 - compile -> compiles the source code
74 - javadoc -> generates the API documentation in ./build/javadocs
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
75 - junit -> runs the JUnit tests
76 - coverage -> generates test coverage metrics
77 - eclipse -> generates an Eclipse project (source folders, jars, etc)
d27134e Moved instructions from build.xml to README.txt and polished them.
jhunter authored
78 - clean -> restores the distribution to its original and clean state
79
80 To learn the details of what each target does, read the build.xml file. It is
81 quite understandable.
82
2d4f269 Added section on how to do bug reports.
jhunter authored
83
84 Bug Reports
85 ===========
86
87 Bug reports go to the jdom-interest list at jdom.org. But *BEFORE YOU POST*
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
88 make sure you've tested against the LATEST code available from GitHub (or the
2d4f269 Added section on how to do bug reports.
jhunter authored
89 daily snapshot). Odds are good your bug has already been fixed. If it hasn't
90 been fixed in the latest version, then when posting *BE SURE TO SAY* which
cb64bd6 @hunterhacker Made the README.txt a bit more modern. Added the new usage commands to b...
authored
91 code version you tested against. For example, "GitHub from October 3rd". Also
2d4f269 Added section on how to do bug reports.
jhunter authored
92 be sure to include enough information to reproduce the bug and full exception
93 stack traces. You might also want to read the FAQ at http://jdom.org to find
94 out if your problem is not really a bug and just a common misunderstanding
95 about how XML or JDOM works.
a652c0e Noting what's new for this release. Updating copyright headers.
jhunter authored
96
97
98 Searching for Information
99 =========================
100
101 The JDOM mailing lists are archived and easily searched at
102 http://jdom.markmail.org.
Something went wrong with that request. Please try again.