README

   1 JPCTB - a client for uploading to Yarrg and PCTB
   2 ================================================
   3
   4 See the YARRG website for more information:
   5   http://yarrg.chiark.net/upload
   6
   7 Linux
   8 -----
   9
  10 To run on Linux run this command from wherever you unpacked the JPCTB
  11 distribution:
  12
  13 ./jpctb /path/to/yohoho/yohoho
  14
  15
  16 Windows
  17 -------
  18
  19 On Windows, double-click jpctb-setup.exe to install JPCTB.  It will do
  20 one of two things:
  21
  22 1) Just work, in which case you'll have a new icon on your desktop which
  23    runs Puzzle Pirates with JPCTB integrated
  24
  25 2) Fail, and tell you what to do next.  Usually this means installing a
  26    Java Runtime Environment (or JVM) and then uninstalling and re-
  27    installing Puzzle Pirates.  (Don't worry about reinstalling; you
  28    won't lose any of your pirates or pieces of eight!)
  29
  30
  31 Source
  32 ------
  33
  34 To build from source you will need a Java SDK, version 6, and Apache
  35 ant, as well as NSIS to build the Windows installer package.
  36
  37 You can run the script "build-sh" do to the build:
  38   ./build-sh
  39
  40 It will create in the current directory (the top level of the build)
  41 the .jar files for JPCTB and also the two distribution files:
  42   jpctb-setup.exe   the installer for windows users
  43   jpctb.tar.gz      a filtered tarball of this whole directory, for linux users
  44
  45 Currently the build only seems to work with the Sun JDK, so the script
  46 sets JAVA_HOME to /usr/lib/jvm/java-6-sun.  If that's not what you
  47 want, set JAVA_HOME yourself.
  48
  49 To make shipping the files a bit easier it prints a rune for rsyncing
  50 the files to the test version on the distribution site.  You can set
  51 JPCTB_PUBLISH_BASE and ..._DIR to control the exact output.
  52
  53 If you want to clean out the build directory to make sure you get a
  54 rebuild from scratch, say
  55   git-clean -x -f -d
  56
  57
  58 Bugs
  59 ----
  60
  61 Current known bugs include:
  62
  63 * Does not work from the Booty Pillaged screen, even though that has a
  64   buy/sell commodities interface.
  65