f9f2526a0f55e97406e9f025755429d1e35b6180
[the-mall.git] / README
1 The recommended way to get a copy of this game is a recursive clone:
2
3     git clone --recursive https://jxself.org/git/the-mall.git
4
5 This will clone all submodules recursively. If you did not perform a
6 recursive clone, once you have a copy of this git repository you will
7 also need the source code for the standard library:
8
9     git submodule update --init --recursive
10
11 You also need to have my modified version of the Inform compiler. See 
12 https://jxself.org/git/?p=inform.git to download and install the 
13 compiler on your system.
14
15 Once the compiler has been compiled and is ready for use return to 
16 this directory and run:
17
18         inform +include_path=lib the-mall
19
20 Or you can run the included build.sh script which does the same thing.
21
22 You will then get the story file for this game that can be run using 
23 any appropriate Z-Machine interpreter, such as Frotz. Your GNU/Linux 
24 distro probably has that packaged already for easy installation.
25
26 --
27 Copyright (C) 2019, 2022 Jason Self <j@jxself.org>
28
29 This file is free software: you may copy, redistribute and/or modify 
30 it under the terms of the GNU Affero General Public License as 
31 published by the Free Software Foundation, either version 3 of the 
32 License, or (at your option) any later version.
33
34 This file is distributed in the hope that it will be useful, but 
35 WITHOUT ANY WARRANTY; without even the implied warranty of 
36 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
37 Affero General Public License for more details.
38
39 You should have received a copy of the GNU Affero General Public 
40 License along with this file. If not, see https://gnu.org/licenses/