3aabb24fb081bb347a1204114be3ac57a9ef80b1
[zilutils.git] / README.md
1 The zilutils comprise a compiler and assembler that target the 
2 Z-Machine. The Z-Machine is a virtual machine developed by the people 
3 at Infocom for their games: <https://en.wikipedia.org/wiki/Z-machine>.
4
5 The zilutils are licensed under version 3 of the GNU Affero General 
6 Public License or, at your option, any later version. See COPYING for 
7 details.
8
9 It is currently a work-in-progress. All contributions are welcome.
10
11 To build this you will need a C compiler (GCC is assumed although 
12 others may work), GNU Autoconf, and GNU Make. Your GNU/Linux distro 
13 probably has these already packaged for easy installation.
14
15 Once these are installed first run autoreconf --install then you 
16 should be able to do the usual dance of:
17
18 ./configure
19 make
20 make install
21
22 You can invoke the configure script with --help to see additional 
23 information.
24
25 Licensing
26 =========
27
28 This file is part of zilutils.
29
30 You can redistribute and/or modify this file under the terms of the 
31 GNU Affero General Public License as published by the Free Software 
32 Foundation, either version 3 of the license, or (at your option) any 
33 later version.
34
35 This file is distributed in the hope that it will be useful, but 
36 WITHOUT ANY WARRANTY; without even the implied warranty of 
37 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
38 Affero General Public License for more details.
39
40 You should have received a copy of the GNU Affero General Public 
41 License along with this file. If not, see 
42 <http://www.gnu.org/licenses/>
43
44 \$-- SPDX-License-Identifier: AGPL-3.0-or-later