X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=README;h=f9f2526a0f55e97406e9f025755429d1e35b6180;hb=b5b31bfc55ce97d644300e1ffdf025097307ca64;hp=41c3e8edf392a7c4359c9e6e682a3de81fb0a12b;hpb=64142318a2cfa3261d1e0062aa84b466499d2978;p=the-mall.git diff --git a/README b/README index 41c3e8e..f9f2526 100644 --- a/README +++ b/README @@ -1,26 +1,30 @@ -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 -You will also need my modified version of the Inform compiler from -https://jxself.org/git/?p=inform.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 +compiler on your system. Once the compiler has been compiled and is ready for use return to this directory and run: inform +include_path=lib the-mall -Or you can run the included build.sh script which does the same thing, -assuming that the inform compiler is included in your PATH. +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 +Copyright (C) 2019, 2022 Jason Self This file is free software: you may copy, redistribute and/or modify it under the terms of the GNU Affero General Public License as