Add readme

[jarrg-owen.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..5f4d811
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+JPCTB - a client for uploading to Yarrg and PCTB
+================================================
+
+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
+
+Windows
+-------
+
+On Windows, double-click windows-setup.vbs 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
+   runs Puzzle Pirates with JPCTB 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-
+   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.
+
+cd src
+ant -f PCTB.xml
+