chiark / gitweb /
move all licences to top level directory; include Sun Java accessibility licence...
[jarrg-ian.git] / README
diff --git a/README b/README
index 9658f4c..c7528e3 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,26 @@
-JPCTB - a client for uploading to Yarrg and PCTB
+JARRG - a client for uploading to Yarrg and PCTB
 ================================================
 
+See the YARRG website for more information:
+  http://yarrg.chiark.net/upload
+
 Linux
 -----
 
-To run on Linux run this command from wherever you unpacked the JPCTB
+To run on Linux run this command from wherever you unpacked the JARRG
 distribution:
 
-./jpctb /path/to/yohoho/yohoho
+./jarrg /path/to/yohoho/yohoho
 
 
 Windows
 -------
 
-On Windows, double-click jpctb-setup.exe to install JPCTB.  It will do
+On Windows, double-click jarrg-setup.exe to install JARRG.  It will do
 one of two things:
 
 1) Just work, in which case you'll have a new icon on your desktop which
-   runs Puzzle Pirates with JPCTB integrated
+   runs Puzzle Pirates with JARRG integrated
 
 2) Fail, and tell you what to do next.  Usually this means installing a
    Java Runtime Environment (or JVM) and then uninstalling and re-
@@ -31,20 +34,25 @@ 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.
 
-You can run the script "build-sh" do to the build.  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
+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 JARRG and also the two distribution files:
+  jarrg-setup.exe   the installer for windows users
+  jarrg.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.
 
 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.
+the files to the test version on the distribution site.  You can set
+JARRG_PUBLISH_BASE and ..._DIR to control the exact output.
+
+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