Development Setup

From Jin

The purpose of this page is to help you obtain and compile Jin's source code. The page assumes a reasonable level of expertise with development tools.

Contents

Tools

A list of the tools you will need to download, compile and run Jin:

  • A web browser. If you are reading this page, you probably already have one, though.
  • The Java Development Kit (JDK) (you don't need the extras on that page).
  • Apache Ant, which is the tool that manages the process of Jin's compilation.
  • If you will be using the source code of a release, you will need an archiver which can handle .tar.gz files, like 7-zip (winzip works too).
  • If you will be using the latest source code from CVS, you will need a CVS client, such as CvsGui.

Getting the Source Code

There are two options for obtaining Jin's source code - you can either download the source code of the latest release, or get the bleeding edge straight from CVS. The former option is safer, since a stable release is always guaranteed to compile and run reasonably well, but it is not appropriate if you need to be in sync with the latest developments. The latter option should give you all the latest and greatest, but it may even fail to compile, much less run. Which option to use depends on what you want to do with it.

Latest Release

To obtain the source code of the latest release, go to Jin's SourceForge.net files page and download the Jin src file. At the moment of this writing, that would be jin-2.13.1-src.tar.gz. The file is a .tar.gz archive, so you will need to extract it.

CVS

The Jin SourceForge.net CVS page explains everything you need to get Jin's latest source code from CVS.

Compiling

To compile Jin from the command line, change to the directory where you've put the Jin source code (it should have a file named build.xml) and type "ant". This will run the tool which compiles Jin. If everything is successful, Ant will print something like this at the end:

BUILD SUCCESSFUL
Total time: 17 seconds

At this point, Ant should have created a subdirectory named build; change into it and type "java -jar jin.jar" to run Jin.

Congrats! Now go and add an interesting feature! :-)