</%doc>
<& docshead &>
-<%perl>
+<%shared>
my $url_base_base= 'http://yarrg.chiark.net/download/jarrg';
-my $download_version= 'test';
-my $url_base= "$url_base_base/$download_version";
-</%perl>
+</%shared>
+<%def downloadurl><%args>
+$leaf
+$test => 0
+# ^ change this to change the default version
+</%args><%perl>
+my $download_version= $test ? '/test' : '';
+my $url_base= "$url_base_base$download_version";
+my $url= $url_base.'/'.$leaf;
+</%perl><a href="<% $url %>"><%
+ $m->has_content ? $m->content : $url
+%></a></%def>
<h1>Uploading to YARRG</h1>
<p>
It is OK to switch away from the commodity list in Puzzle Pirates as
soon as the Jarrg progress bar appears. The uploader has taken a copy
-of the data, so you do something else while the upload takes place.
+of the data, so you can do something else while the upload takes
+place.
<p>
<h3>Installing and running on Linux</h3>
Download
-<a href="<% $url_base %>/jarrg.tar.gz"><% $url_base %>/jarrg.tar.gz</a>
+<& downloadurl, leaf => 'jarrg-linux.tar.gz' &>
and unpack it. You run jarrg from the command line. Change
(<code>cd</code>) to the top level <code>jarrg</code> directory
which was created when you unpacked the tarball, and then run
<h3>Installing on Windows</h3>
Download
-<a href="<% $url_base %>/jarrg-setup.exe"><% $url_base %>/jarrg-setup.exe</a>
+<& downloadurl, leaf => 'jarrg-setup.exe' &>
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
<h2>How does it work? Is it a violation of the Terms of Service?</h2>
+JARRG (and the old OCR clients) comply with Three Rings' official
+<a href="http://yppedia.puzzlepirates.com/Official:Third_Party_Software">Third Party Software Policy</a>.
+
+<p>
+
Essentially, JARRG is a specialised "screen reader" which instead of
reading information out loud, uploads it to the YARRG and PCTB
databases.
<h2><a name="source">Authorship, source code and other versions</a></h2>
Thanks to Burninator for writing the core of the JARRG client. Ian
-Jackson and Owen Dunn adapted it to improve the installation setup (in
-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.
+Jackson and Owen Dunn adapted it to fix bugs and to improve the
+installation setup (in 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>
JARRG is
Copyright 2006-2009 Burninator,
Copyright 2009-2010 Owen Dunn and
-Copyright 2009-2010 Ian Jackson.
+Copyright 2009-2011 Ian Jackson.
It is Free Software with <strong>NO WARRANTY</strong>, released under
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> .
+The code for the downloadable binaries is in
+in <& downloadurl, leaf=>'jarrg-source.tar.gz' &>.
+The download directory also sometimes contains other versions
+(eg unreleased test versions), which you can see here:
+ <& downloadurl, leaf => '', test => 0 &>
<p>
-The source code for the downloadable released binaries is in the
-<a href="<% $url_base %>/jarrg.tar.gz">Linux
-tarball</a>. We maintain JARRG in git, and you can get
+We maintain JARRG in git, and you can get
source code for recent and perhaps unreleased versions from one of:
<pre>
git://git.yarrg.chiark.net/jarrg-ian.git</code> <a href="http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=jarrg-ian.git;a=summary">(gitweb)</a>