README.source

   1 Ganymede Release 2.0
   2 17 April 2013
   3 README.source
   4
   5 ---------------------------------------------
   6
   7 This release of Ganymede includes full sources for everything, with
   8 the exception of certain freely distributable classes provided from
   9 the ANTLR and Jython projects.
  10
  11 By default, the Ganymede distribution comes without any of the actual
  12 Ganymede code compiled into classes and Jar files.  The first time you
  13 run configure, the Ganymede tree will be built for you and turned into
  14 Jar files.
  15
  16 Thereafter, if you want to mess with the source and rebuild, here's
  17 what you do:
  18
  19 1. cd src
  20
  21 2. Run 'ant'.  This will compile the classes for all of the
  22    source code in the source tree.  Once this completes, any
  23    source files that have been changed since the initial configure
  24    will be recompiled, and their class files placed under
  25    src/build/classes.
  26
  27 3. Run 'ant jars'.  This will recreate the 4 jar files used by
  28    the installation scripts.
  29
  30 4. Copy your new jar files into your pre-existing server and client
  31    jars directories.
  32
  33 Keep in mind that Ganymede 2.0 includes cryptographic material in the
  34 jar files it generates, and the client and server jar files must be
  35 cryptographically mated.  Upon the first build of your jar files,
  36 these unique cryptographic materials will be created and stored in
  37 src/build/crypto, and all jar files created from this tree thereafter
  38 will re-use this material as needed.  You can't just take a client.jar
  39 file built from an arbitrary Ganymede src tree and expect it to work
  40 with a server.jar file produced from a different copy of the src tree.
  41
  42 The Ant build file has a lot of possible options and operations,
  43 including some that deal specifically with the production of the
  44 cryptographic materials.
  45
  46 To find out more about what you can do to the Ganymede source tree
  47 with Ant, run 'ant help' in the src directory, or read the build.xml
  48 file in src for more details.
  49
  50 Jonathan Abbey
  51 jonabbey@arlut.utexas.edu