TrekBuddy Atlas Creator - Readme for Developers

Welcome to the develop documentation of TrekBuddy Atlas Creator (TAC). First please read the standard readme for all users.

Code access

If you want do get your hands on the latest source code of TrekBuddy Atlas Creator you can checkout the code from the Subversion repository at SourceForge:

https://trekbuddyatlasc.svn.sourceforge.net/svnroot/trekbuddyatlasc/trunk/TAC

There you will find the latest sources of TAC in form of an Eclipse (v3.4) project. All tools, libraries, sources and build files are included in this repository. The only exception is Apache Ant) which is used for building the jar version of TAC and of course the Java Development Kit (JDK).

Building TAC

For building TAC please run Apache Ant on the provided file build.xml

The default build target performs all necessary tasks for compiling the sources, packaging the classes to a jar and then minimizing the size of the jar using ProGuard (lib/proguard.jar).
Additionally the build steps include a call to lib/svnversion.jar which is a Java only version of the command svnversion (bases on SVNKit). This command updates the SVN revision information in file src/tac/tac-rev.properties which is included in the final jar of TAC.

Guidelines for publishing custom builds/releases

If you modify TrekBuddy Atlas Creator and you want to publish it yourself please consider the following guidelines:

  1. Chose a version/release name that makes it clear that it is not an official release: Change the version string to refelect that.
    Example: 1.6 beta 3 XYZ edition
    The version string is located in the properties file src/tac/tac.properties. Change the entry tac.version to your custom release name.
  2. Do not forget that TrekBuddy Atlas Creator is a GPL project - therefore publishing the source code together with the binary release should went without saying.
  3. If your modification is useful you may consider to present it to the TrekBuddy Atlas Creator development team. Patches are always welcome. Useful modifications have a great chance to be integrated into the main branch.

Participation

If you are familiar with the programming language Java and you want to contribute or participate in the development process of TAC feel free to contact one of the other developers of TAC listed at SourceForge.