X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=README;fp=README;h=ed6427e9b1a9b70993c30c94022bf00c570969bf;hb=5933145f3af963dc81d276f8fb42247b9be51192;hp=371243d255cb41403398780a1a51ce991af8d123;hpb=a6b0bbded9f21b67e6c5509b3260454bc41048e1;p=spiritwrak.git

diff --git a/README b/README
index 371243d..ed6427e 100644
--- a/README
+++ b/README
@@ -3,18 +3,46 @@ This repository contains a copy of SPIRITWRAK by D. S. Yu.
 https://ifdb.tads.org/viewgame?id=tqpowvmdoemtooqf
 http://mirror.ifarchive.org/if-archive/games/source/inform/spiritw_src.zip
 
+The recommended way to get a copy of this git repository is a
+recursive clone:
+
+    git clone --recursive https://jxself.org/git/?p=spiritwrak.git
+
+This will clone all submodules recurively. If you did not perform a
+recurive clone, once you have a copy of this git repository you will
+also need the source code for the standard library:
+
+	git submodule update --init --recursive
+
+To compile this game you will also need my modified version 6 of the
+Inform compiler from https://jxself.org/git/?p=inform.git
+
+Once the compiler has been compiled and is ready for use return to
+this directory and run:
+
+    inform '$huge' '$MAX_OBJECTS=1000' '$MAX_SYMBOLS=8150' \
+    '$MAX_CLASSES=50' '$MAX_DICT_ENTRIES=1500' \
+    '$MAX_ZCODE_SIZE=200000' ++include_path=src ++include_path=lib \
+    -v8 src/spirit
+
+Or you can run the included build.sh script which does the same thing.
+
+You will then get the story file for this game 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) 2019 Jason Self <j@jxself.org>
 
-You may copy, redistribute and/or modify this file 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 
+You may copy, redistribute and/or modify this file 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.
 
-This file 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 
+This file 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 file. If not, see https://gnu.org/licenses/
+You should have received a copy of the GNU General Public License
+along with this file. If not, see https://gnu.org/licenses/
\ No newline at end of file