Add the hotel founder's middle name to the bronze plaque
[snowed-in.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/snowed-in.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 To compile this game you will also need my modified version of the 
12 Inform compiler from https://jxself.org/git/?p=inform.git
13
14 Once the compiler has been compiled and is ready for use return to 
15 this directory and run:
16
17     inform +include_path=lib src/snowed-in
18
19 Or you can run the included build.sh script which does the same thing, 
20 assuming that the inform compiler is included in your PATH.
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 A great big thanks to David Griffith for keeping Inform 6 alive.
27
28 --
29 Copyright (C) 2021 Jason Self <j@jxself.org>
30
31 This file is free software: you may copy, redistribute and/or modify 
32 it under the terms of the GNU Affero General Public License as 
33 published by the Free Software Foundation, either version 3 of the 
34 License, or (at your option) any later version.
35
36 This file is distributed in the hope that it will be useful, but 
37 WITHOUT ANY WARRANTY; without even the implied warranty of 
38 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
39 Affero General Public License for more details.
40
41 You should have received a copy of the GNU Affero General Public 
42 License along with this file. If not, see https://gnu.org/licenses/