Adapt name of jar file in debian/jabref.{install,links}.
[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). Don't know what version is
8   needed; the latest stable version should work fine.
9
10 To compile, use the command "ant jars".
11 After the build is finished, you can find the executable jar file
12 named "JabRef-$VERSION.jar" (where $VERSION is the current version of the
13 source tree) in the "build/lib" directory. Enjoy!
14
15 You can also build and run JabRef directly with the command "ant run".
16
17 On Mac OS X you should include the targets osx and osxjar,
18 making the correct command "ant compile unjarlib osx jars osxjar".
19 AFter the build is finished, you will find the OS X application
20 "JabRef.app" in the "build/lib" directory along with the executable
21 jar.
22
23 If you have the required libraries (found as jar files in the "lib"
24 directory in your classpath, you can remove the "unjarlib" target to
25 avoid these libraries being bundled inside the JabRef jar.
26
27
28
29 Morten Alver
30 Revised October 9, 2007.