somewhat improve the jpctb docs

[ypp-sc-tools.db-test.git] / yarrg / web / upload

diff --git a/yarrg/web/upload b/yarrg/web/upload
index 5eff2c476b623a40d1759f289caf2b3229305566..f6e0fce843ec0f4d67154fac767429caf7d475a4 100755 (executable)
--- a/yarrg/web/upload
+++ b/yarrg/web/upload
@@ -34,6 +34,11 @@
 
 </%doc>
 <& docshead &>
+<%perl>
+my $url_base_base= 'http://yarrg.chiark.net/download/jpctb';
+my $download_version= 'test';
+my $url_base= "$url_base_base/$download_version";
+</%perl>
 <h1>Uploading to YARRG</h1>
 <p>
 
@@ -84,9 +89,10 @@ report the problem to us, not to Three Rings.
 <h3>Installing and running on Linux</h3>
 
 Download
-<a href="http://yarrg.chiark.net/download/jpctb/test/jpctb.tar.gz">http://yarrg.chiark.net/download/jpctb/test/jpctb.tar.gz</a>
-and unpack it.  You run it from the command line.  Change
-to the directory where you unpacked the tarball above, and then run
+<a href="<% $url_base %>/jpctb.tar.gz"><% $url_base %>/jpctb.tar.gz</a>
+and unpack it.  You run jpctb from the command line.  Change
+(<code>cd</code>) to the top level <code>jpctb</code> directory
+which was created when you unpacked the tarball, and then run
 <pre>
 ./jpctb /path/to/yohoho/yohoho
 </pre>
@@ -97,7 +103,7 @@ ordinary Puzzle Pirates startup script, which is normally
 <h3>Installing on Windows</h3>
 
 Download
-<a href="http://yarrg.chiark.net/download/jpctb/test/jpctb-setup.exe">http://yarrg.chiark.net/download/jpctb/test/jpctb-setup.exe</a>
+<a href="<% $url_base %>/jpctb-setup.exe"><% $url_base %>/jpctb-setup.exe</a>
 and double-click on it.  It will either:
 <ol>
 <li>Just work, in which case you'll have a new icon on your desktop which
@@ -141,22 +147,22 @@ core game functionality which would make cheating possible.
 
 <p>
 
-JPCTB works by running an unmodified copy of the YPP client but with
-a separate JVM (Java Virtual Machine) configured to use the
-appropriate accessibility plugin.  We do this (rather than configuring
-the computer's main JVM to use the JPCTB accessibility plugin) so that
-it is still possible to launch Puzzle Pirates <em>without</em> JPCTB
-(for example, in case the JPCTB client should cause any kind of
-problem).
+JPCTB runs the unmodified Puzzle Pirates game, but with a separate
+copy of your system's JVM (Java Virtual Machine); that copy of the JVM
+is configured to use the JPCTB accessibility plugin.  We do this
+(rather than configuring the computer's main JVM to use the
+accessibility plugin) to avoid interfering with other uses of Java on
+your computer - in particular, so that it is always possible to launch
+Puzzle Pirates <em>without</em> JPCTB (for example, in case the plugin
+should cause any kind of problem).
 
-<h2>Authorship and source code</h2>
+<h2>Authorship, source code and other versions</h2>
 
 Thanks to Burninator for writing the core of the JPCTB client.  Ian
 Jackson and Owen Dunn adapted it to improve the installation setup (in
-particular, to more completely avoid modifying the YPP client's
-startup files, which Three Rings unsurprisingly objected to).  Owen
-Dunn added support for uploading to YARRG, updated the build system,
-and wrote a Windows installer.
+particular, to avoid modifying any of the YPP client's startup files).
+Owen Dunn added support for uploading to YARRG, updated the build
+system, and wrote a Windows installer.
 
 <p>
 
@@ -169,11 +175,18 @@ the MIT-style two-clause licence.
 
 <p>
 
+The download directory can contains other versions (eg unreleased test
+versions), which you can see here:
+ <a href="<% $url_base_base %>/"><% $url_base_base %>/</a> .
+
+<p>
+
 The source code for the downloadable released binaries is in the
-<a href="http://yarrg.chiark.net/download/jpctb/test/jpctb.tar.gz">Linux
+<a href="<% $url_base %>/jpctb.tar.gz">Linux
 tarball</a>.  We maintain YARRG JPCTB in git, and you can get
 source code for recent and perhaps unreleased versions from
-<code>git://git.yarrg.chiark.net/jpctb.git</code>.
+<code>git://git.yarrg.chiark.net/jpctb.git</code> and/or
+<code>git://git.chiark.greenend.org.uk/~ijackson/jpctb.git</code> .
 
 
 </div>