document how to make a clean build

[jarrg-owen.git] / README

diff --git a/README b/README
index dc7902bcf6c619a4a6042606c438a82b1740d7dd..6feb43981af0cca60c8598640fa2f61c1b654cfd 100644 (file)
--- a/README
+++ b/README
@@ -9,6 +9,7 @@ distribution:
 
 ./jpctb /path/to/yohoho/yohoho
 
+
 Windows
 -------
 
@@ -23,19 +24,33 @@ one of two things:
    installing Puzzle Pirates.  (Don't worry about reinstalling; you
    won't lose any of your pirates or pieces of eight!)
 
+
 Source
 ------
 
 To build from source you will need a Java SDK, version 6, and Apache
 ant, as well as NSIS to build the Windows installer package.
 
-  cd src
-  ant -f PCTB.xml
+You can run the script "build-sh" do to the build:
+  ./build-sh
+
+It will create in the current directory (the top level of the build)
+the .jar files for JPCTB and also the two distribution files:
+  jpctb-setup.exe   the installer for windows users
+  jpctb.tar.gz      a filtered tarball of this whole directory, for linux users
+
+Currently the build only seems to work with the Sun JDK, so the script
+sets JAVA_HOME to /usr/lib/jvm/java-6-sun.  If that's not what you
+want, set JAVA_HOME yourself.
 
-Currently this only seems to work with the Sun JDK.  If your default
-JDK is OpenJDK then the following rune may work better:
+To make shipping the files a bit easier it prints a rune for rsyncing
+the files to the distribution site with a pathname based on the output
+from "git-describe".  You can set JPCTB_PUBLISH_BASE and ..._DIR to
+control the exact output.
 
-  JAVA_HOME=/usr/lib/jvm/java-6-sun ant -f PCTB.xml
+If you want to clean out the build directory to make sure you get a
+rebuild from scratch, say
+  git-clean -x -f -d
 
 
 Bugs