Exclude .gitmodules from git archive

[the-mall.git] / README

diff --git a/README b/README
index 2ddea60b07a667e0c51372bf95189e0b94349872..f9f2526a0f55e97406e9f025755429d1e35b6180 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,21 @@
-To compile this game first pull in my modified version of the Inform 
-standard library:
+The recommended way to get a copy of this game is a recursive clone:
 
-       git submodule init
-       git submodule update
+    git clone --recursive https://jxself.org/git/the-mall.git
 
-First build the compiler:
+This will clone all submodules recursively. If you did not perform a
+recursive clone, once you have a copy of this git repository you will
+also need the source code for the standard library:
 
-       cd inform
-       gcc *.c -o inform
-       cd ../
+    git submodule update --init --recursive
+
+You also need to have my modified version of the Inform compiler. See 
+https://jxself.org/git/?p=inform.git to download and install the 
+compiler on your system.
 
 Once the compiler has been compiled and is ready for use return to 
 this directory and run:
 
-       ./inform/inform +include_path=lib the-mall
+       inform +include_path=lib the-mall
 
 Or you can run the included build.sh script which does the same thing.
 
@@ -22,7 +24,7 @@ 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>
+Copyright (C) 2019, 2022 Jason Self <j@jxself.org>
 
 This file is free software: you may copy, redistribute and/or modify 
 it under the terms of the GNU Affero General Public License as