Update the README to mention recursive clone
authorJason Self <j@jxself.org>
Sat, 5 Feb 2022 20:11:01 +0000 (12:11 -0800)
committerJason Self <j@jxself.org>
Sat, 5 Feb 2022 20:11:01 +0000 (12:11 -0800)
README

diff --git a/README b/README
index dc509aeca17fc78c3d760bd310f8173ae83ae70a..f9f2526a0f55e97406e9f025755429d1e35b6180 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,12 @@
-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
+
+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:
+
+    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 
@@ -20,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