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