yarrg/web/scraper

   1 <%doc>
   2
   3  This is part of the YARRG website.  YARRG is a tool and website
   4  for assisting players of Yohoho Puzzle Pirates.
   5
   6  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   7  Copyright (C) 2009 Clare Boothby
   8
   9   YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
  10   The YARRG website is covered by the GNU Affero GPL v3 or later, which
  11    basically means that every installation of the website will let you
  12    download the source.
  13
  14  This program is free software: you can redistribute it and/or modify
  15  it under the terms of the GNU Affero General Public License as
  16  published by the Free Software Foundation, either version 3 of the
  17  License, or (at your option) any later version.
  18
  19  This program is distributed in the hope that it will be useful,
  20  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  GNU Affero General Public License for more details.
  23
  24  You should have received a copy of the GNU Affero General Public License
  25  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  28  are used without permission.  This program is not endorsed or
  29  sponsored by Three Rings.
  30
  31
  32  This Mason component generates information about the old yarrg client.
  33
  34
  35 </%doc>
  36 <& docshead &>
  37 <h1>"yarrg" screenscraper for YARRG and PCTB</h1>
  38
  39 There is an obsolete screenscraper for Linux, known as "yarrg".  It is
  40 much slower and less reliable than JPCTB.  We recommend you use
  41 <a href="upload">YARRG JPCTB</a> instead.
  42
  43 <h2>Instructions for using obsolete "yarrg"</h2>
  44
  45 <p>
  46
  47 The current official version of the yarrg screenscraper can browsed here:
  48  <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a> .
  49 See particularly the
  50 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
  51
  52 <p>
  53 To install the client, install the "git" version control system
  54 and the other dependencies listed in the "Installation requirements"
  55 section of the README and then run:
  56 <pre>
  57 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
  58 cd ypp-sc-tools
  59 cd yarrg
  60 make
  61 </pre>
  62 this will download the code into the directory <code>ypp-sc-tools</code>,
  63 and build the software.  (If your Linux is very up to date you may
  64 find that it complains that it doesn't know the command <kbd>git-core</kbd>.
  65 In that case, use <kbd>git core</kbd>, with a space, instead.)
  66
  67 <p>
  68
  69 When new versions of the upload client are released, you can:
  70 <pre>
  71 cd .../ypp-sc-tools
  72 git-pull
  73 cd yarrg
  74 make
  75 </pre>
  76 to fetch the new version.  (Again, you may need <kbd>git pull</kbd>
  77 instead of <kbd>git-pull</kbd>.)
  78
  79 <h2>Windows and MacOS</h2>
  80 <p>
  81 The yarrg scraper would be almost impossible to port to Windows.  In
  82 any case it is obsolete.
  83
  84 </div>
  85 <& footer &>