Changeset 35682 for main/trunk/release-kits/README.txt

Timestamp:

2021-10-23T18:47:29+13:00 (2 years ago)

Author:

davidb

Message:

Text/commment/echo/README tidy up

File:

• main/trunk/release-kits/README.txt (modified) (2 diffs)

main/trunk/release-kits/README.txt

@@ -22 +22 @@
 
 
+##
 # Getting Ready to use the Release Kit
 
-To use the Release Kit scripts, some source code needs to be compile first:
+It used to be that you needed to compile up the Release Kit to use the
+custom Ant Tasks it relied on.  However as the source code is 100%
+Java, JDK8 compile up jars have been produced and committed, so it now
+can be used immediately after an svn checkout.
 
-  ant compile
+It also used to be left to the developer to set their environment to
+the Release Kit scripts in <rkhome>/bin were found.  This is now
+take care of by:
 
-And the Release Kits 'bin' directory added to your PATH.  
-For Linux, for example:
+  . ./rk-setup.bash   (Unix)
+or
+  rk-setup.bat        (Windows)
 
-  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 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-16 32-bit):
@@ -56 +58 @@
   # 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
+
+For a Linux 64-bit build, add in:
+
+  echo x64:true>> rk3-build.properties
+  
+
+The kick off the whole process with:
 
   rk3
 
+The end result is an installer for Greenstone in:
 
-More detailed notes at:
+  products
+  
+
+##
+# Updating the Java source code to the Release Kit code base
+
+In the event any changes are made the custom Java based tasks the
+Release Kit provides, then the sequence to regenerate the compiled
+jar files is:
+
+  . ./gs3-setup.bash
+
+  ant compile
+
+  svn commit -m "<message>" \
+    shared/core/ant-tasks/greenstone/anttasks.jar \
+    shared/core/ant-installer/lib/ant-installer.jar \
+    shared/core/ant-installer/lib/ant-installer-ext.jar
+
+
+====
+
+# More detailed notes in general about the Release Kit code at:
 
   http://wiki.greenstone.org/doku.php?id=en:developer:release_kits