Peter Maydell points out that the README misspells `Makefile' as
[sgt/puzzles] / README
1 This is the README accompanying the source code to Simon Tatham's
2 puzzle collection.
3
4 You should find several Makefiles in the source code:
5
6 - `Makefile' should work under GNU make on Linux, provided you have
7 GTK installed to compile and link against. It builds GTK binaries
8 of the puzzle games.
9
10 - `Makefile.vc' should work under MS Visual C++ on Windows.
11
12 - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate
13 tweaks and setting of TOOLPATH, it should work for both compiling
14 on Windows and cross-compiling on Unix.
15
16 Each of these Makefiles builds a program called `nullgame' in
17 addition to the actual game binaries. This program doesn't do
18 anything; it's just a template for people to start from when adding
19 a new game to the collection, and it's compiled every time to ensure
20 that it _does_ compile and link successfully (because otherwise it
21 wouldn't be much use as a template). Once it's built, you can run it
22 if you really want to (but it's very boring), and then you should
23 ignore it.
24
25 DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
26 back to the maintainer. The makefiles are generated automatically by
27 the Perl script `mkfiles.pl' from the file `Recipe'. If you need to
28 change the makefiles as part of a patch, you should change Recipe
29 and/or mkfiles.pl.