5 Project Structure

JOTM can be retrieved under two different forms:

• a source form (from a source package or CVS)
• a distribution form (from a distribution package)

Since these two structures differs slightly, I'll present both of them.

5.1 Source Structure

When you retrieve JOTM source, the structure of your jotm/ directory is the following one:

• GettingStarted.txt - a reminder of the main Ant targets for JOTM
• README.txt - the usual README file
• build.xml - the main Ant build file used JOTM
• build.properties - configuration of Ant properties are done in this file
• archive/ - manifest files for JOTM jars are stored in this directory
• bin/ - for the moment, there is only a README.txt file. No scripts are used to start JOTM, only jar files (with the java -jar command)
• doc/ - all documentation sources are in this directory (e.g. install.tex from which this guide has been generated)
• examples/ - the examples source code
• ext/ - the extension used by JOTM. For the moment, it is composed of two files for communication protocol configuration
• externals/ - all libraries to build and use JOTM
• src/ - the source code of JOTM

5.2 Distribution Structure

Once you've built JOTM (i.e. in the output/dist/ subdirectory) or if you retrieved it from the distribution package, the ditribution structure of JOTM is the following:

• README.txt - still the usual README file
• bin/ - the same directory as in the source structure
• config/ - this directory contains all configuration files needed by JOTM at runtime
• doc/ - this directory may contain PDF and HTML version of the various documentation files (see Generate Documentation)
• examples/ - the same directory as in the source structure. You'll have to compile the examples before running them
• jdoc/ - Javadoc of JOTM
• lib/ - JOTM library directory (it contains both JOTM jar files and other used jar files)