New upstream release (closes: #448917, #448027).
[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.4 or higher.
7 * Jakarta Ant (http://ant.apache.org). Don't know what version is
8   needed; the latest stable version should work fine.
9
10 To compile, use the command "ant compile unjarlib jars".
11 After the build is finished, you can find the executable jar file
12 named "jabref.jar" in the "build/lib" directory. Enjoy!
13
14 You can also build and run JabRef directly with the command "ant run".
15 Note that this will not run the "unjarlib" target that bundles 3rd party
16 libraries inside the jar file.
17
18 On Mac OS X you should include the targets osx and osxjar,
19 making the correct command "ant compile unjarlib osx jars osxjar".
20 AFter the build is finished, you will find the OS X application
21 "JabRef.app" in the "build/lib" directory along with the executable
22 jar.
23
24 If you have the required libraries (found as jar files in the "lib"
25 directory in your classpath, you can remove the "unjarlib" target to
26 avoid these libraries being bundled inside the JabRef jar.
27
28
29
30 Morten Alver
31 Revised June 11, 2005.