Adding initial work on Grue Hunter 2.0

[grue-hunter.git] / README

diff --git a/README b/README
index 512855a27bcd94548edef2698d1b7e9dca04876f..d78645105cd2588fcddf9925a44555a5f55b469d 100644 (file)
--- a/README
+++ b/README
@@ -1,34 +1,47 @@
-This directory contains version 1.0 of Grue Hunter.
+This directory contains version 2.0 of Grue Hunter.
 
-Homepage: http://jxself.org/grue-hunter.shtml
+Homepage: https://jxself.org/grue-hunter.shtml
 
 This file is part of Grue Hunter. See the end of the file for license 
 conditions.
 
        "It is pitch black. You are likely to be eaten by a grue."
 
-The Grue has eaten many adventurers. This game gives you a chance to get even.
+The Grue has eaten many adventurers. This game gives you a chance to 
+get even.
 
-Grue Hunter is a text adventure game written in Perl. You must make your way 
-through an underground cave system in search of the Grue. Can you capture it 
-and get out alive?
+To compile the game first pull in my modified version of the Inform 
+standard library:
 
-To run the program, type './gh.pl' from within the Grue Hunter directory.
+       git submodule init
+       git submodule update
 
-Copyright (C) 2013 Jason Self <j@jxself.org>
+You will also need my modified version of the Inform compiler from 
+https://jxself.org/git/?p=inform.git
 
-Grue Hunter gives you software freedom; you can copy, modify, convey,
-and/or redistribute it under the terms of the GNU Affero General Public
-License as published by the Free Software Foundation; either version 3 of 
-the License, or (at your option) any later version.
+Once the compiler has been compiled and is ready for use return to 
+this directory and run:
 
-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 Affero General Public License 
-for more details.
+       inform ++include_path=lib grue-hunter
 
-You should have received a copy of the GNU Affero General Public License 
-along with this program in a file called 'AGPLv3.txt'. If not, see
-http://www.gnu.org/licenses/agpl-3.0-standalone.html or write to the: Free
-Software Foundation, Inc., 51 Franklin St, Fifth Floor Boston, MA 
-02110-1301, USA.
+Or you can run the included build.sh script which does the same thing, 
+assuming that the inform compiler is included in your PATH.
+
+You will then get the Grue Hunter story file that can be run using 
+any appropriate Z-Machine interpreter, such as Frotz. Your GNU/Linux 
+distro probably has that packaged already for easy installation.
+
+Copyright (C) 2013, 2016 Jason Self <j@jxself.org>
+
+Grue Hunter gives you software freedom; you can copy, modify, convey, 
+and/or redistribute it under the terms of the GNU Affero General 
+Public License as published by the Free Software Foundation; either 
+version 3 of the License, or (at your option) any later version.
+
+Grue Hunter 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 
+Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public 
+License along with Grue Hunter. If not, see https://gnu.org/licenses/