UI fixes: jpctb does not run ypp if user closes the control panel; remove option...

[jarrg-owen.git] / README

diff --git a/README b/README
index 5f4d8111d19255ac7edf02e73ff3dd7b73bab0cb..9658f4c1a276c647f4618be87b73dea64e79da47 100644 (file)
--- a/README
+++ b/README
@@ -7,12 +7,13 @@ Linux
 To run on Linux run this command from wherever you unpacked the JPCTB
 distribution:
 
-./jpctb /path/to/dir/with/PCTB*.jar /path/to/yohoho/yohoho
+./jpctb /path/to/yohoho/yohoho
+
 
 Windows
 -------
 
-On Windows, double-click windows-setup.vbs to install JPCTB.  It will do
+On Windows, double-click jpctb-setup.exe to install JPCTB.  It will do
 one of two things:
 
 1) Just work, in which case you'll have a new icon on your desktop which
@@ -23,12 +24,34 @@ 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.
+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
+
+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.
+
+
+Bugs
+----
+
+Current known bugs include:
 
-cd src
-ant -f PCTB.xml
+* Does not work from the Booty Pillaged screen, even though that has a
+  buy/sell commodities interface.