source: main/trunk/release-kits/README.txt@ 35623

# Prerequisites to using the Release Kit code base


  * Java JDK       (min v1.6, typically v1.8 used, known to work with v1.11)
  * Apache ant     (min 1.8.2)
  * C/C++ compiler (e.g., g++ for Linux, Microsoft Visual Studio for Windows, XCode for Mac)
  * Subversion     (min v1.8)

Under Linux (to be confirmed why it is needed)

  * Set the LANG environment variable to use UTF-8, e.g., export LANG=en_NZ.UTF-8


One quick way to get going with these prerequisites is to checkout the 'local' folder
that corresponds to the OS and version Greenstone you are looking to use the
Release Kit on.  For example:

  svn co https://svn.greenstone.org/local/greenstone3/windows-64bit gs3-local-windows64
  
Then refer to the README.txt in the checked-out directory for further details.


# Getting Ready to use the Release Kit

To use the Release Kit scripts, some source code needs to be compile first:

  ant compile

And the Release Kits 'bin' directory added to your PATH.  
For Linux, for example:

  export PATH=$PWD/bin:$PATH

Or for Windows:

  set PATH=%CD%\bin;%PATH%

Finally, for compilation compilation of JNI code in Greenstone3 to be able to
locate the necessary header files (e.g., jni.h), JAVA_HOME needs to be set,

For example (on Ubuntu 32-bit):

  export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-i386


To create a release, for example Greenstone 3 v3.11rc:

  mkdir releases
  cd releases
  
  # In the following the redirect character (>) is hard up against the version number
  #   to avoid a space occuring at end of echo of the line output to the property file
  echo version:3.11rc> rk3-build.properties

  rk3


More detailed notes at:

  http://wiki.greenstone.org/doku.php?id=en:developer:release_kits

and

  http://wiki.greenstone.org/doku.php?id=internal:release_kits