Imported Upstream version 2.10~beta2+ds
[debian/jabref.git] / src / txt / INSTALL
1 Quick instructions, compiling JabRef from source
2 ------------------------------------------------
3
4 To compile JabRef from source, you need:
5
6 * A Java compiler, supporting Java 1.5 or higher.
7 * Jakarta Ant (http://ant.apache.org).
8
9 To compile, use the command "ant jars".
10 After the build is finished, you can find the executable jar file
11 named "JabRef-$VERSION.jar" (where $VERSION is the current version of the
12 source tree) in the "build/lib" directory. Enjoy!
13
14 You can also build and run JabRef directly with the command "ant run".
15
16 On Mac OS X you should include the targets osx and osxjar,
17 making the correct command "ant compile unjarlib osx jars osxjar".
18 AFter the build is finished, you will find the OS X application
19 "JabRef.app" in the "build/lib" directory along with the executable
20 jar.
21
22 If you have the required libraries (found as jar files in the "lib" directory
23 in your classpath, you can edit the build.xml file to skip the "unjarlib"
24 target, in order to avoid these libraries being bundled inside the JabRef jar.
25
26
27
28 Morten Alver
29 Revised October 9, 2007.