chiark / gitweb /
Merge branch 'test-install'
[ypp-sc-tools.db-live.git] / yarrg / README
index a41493e087bfb4b6e243c291ef593fec0b70b1ce..a468b9a7b8832302b652d3d5655a598a76f49079 100644 (file)
@@ -65,10 +65,11 @@ Please do not use options marked * with --upload.  See README.privacy.
 
 Options to override which servers we talk to:
   --yarrg-server HOST|URL When uploading to YARRG, use HOST or URL.
-  --pctb-server HOST|URL  Talk to the PCTB database at HOST or URL.
-  --dict-submit-url URL   Submit dictionary entries with HTTP POST under URL.
+  --pctb-server HOST|URL  When talking to PCTB, use HOST or URL.
+  --dict-submit-url URL   Submit dictionary updates here (default: use yarrg).
   --dict-update-from SRC  Fetch updated master dictionary with rsync from SRC.
-Or set the environment variables YPPSC_YARRG{_PCTB, _DICT_UPDATE, _DICT_SUBMIT}
+Or set the environment variables
+  YPPSC_YARRG{_YARRG, _PCTB, _DICT_UPDATE, _DICT_SUBMIT}
 
 
 Installation requirements
@@ -147,8 +148,8 @@ GUI.
 See README.privacy for full details.
 
 
-Authorship and copyright
-------------------------
+Disclaimers, authorship and copyright
+-------------------------------------
 
 The PCTB server is a project of Joel Lord and various others.
 
@@ -156,32 +157,42 @@ The YARRG server was inspired by PCTB and is a project of the crew
 Special Circumstances (on the Midnight Ocean) and of the Sinister
 Greenend Organisation.
 
+PCTB and YARRG are both completely unofficial and Three Rings, the
+operators of Yohoho Puzzle Pirates, have nothing to do with either of
+them.  Please refer queries to us, not to Three Rings.  If you want to
+reuse the code here to do substantially novel things, you should ask
+Three Rings for permission (for example, by petitioning an Ocean
+Master).
+
 
 This yarrg screenscraper and upload client was written entirely from
-scratch by me, Ian Jackson, with assistance from Stephen Early.  It is
-part of ypp-sc-tools, a set of third-party tools for assisting players
-of Yohoho Puzzle Pirates.
+scratch by me, Ian Jackson, with assistance from Stephen Early and
+Clare Boothby.  It is part of ypp-sc-tools, a set of third-party tools
+for assisting players of Yohoho Puzzle Pirates.
 
-ypp-sc-tools is
+ypp-sc-tools and YARRG are
 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-Copyright (C) 2009 Stephen Early
+Copyright (C) 2009 Clare Boothby
 
 This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+it under the terms of
+ (a) for the website code, the GNU Affero General Public License and
+ (b) for the rest of the code, GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+each applicable the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU General Public License and
+GNU Affero General Public License along with this program.  If not,
+see <http://www.gnu.org/licenses/>.
 
 Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
-are used without permission.  This program is not endorsed or
-sponsored by Three Rings.
+are used without permission.  Once again, this program is not endorsed
+or sponsored by Three Rings.
 
 
 The character and UI images copied from the YPP client, and submitted