Ahem. Rogue copy and paste was causing preset menu items to go into
[sgt/puzzles] / README
CommitLineData
1cdb3e4f 1This is the README accompanying the source code to Simon Tatham's
e91825f8 2puzzle collection. The collection's web site is at
3<http://www.chiark.greenend.org.uk/~sgtatham/puzzles/>.
1cdb3e4f 4
5You should find several Makefiles in the source code:
6
8d79d5d9 7 - `Makefile' should work under GNU make on Linux, provided you have
8 GTK installed to compile and link against. It builds GTK binaries
9 of the puzzle games.
1cdb3e4f 10
11 - `Makefile.vc' should work under MS Visual C++ on Windows.
12
13 - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate
14 tweaks and setting of TOOLPATH, it should work for both compiling
15 on Windows and cross-compiling on Unix.
16
17Each of these Makefiles builds a program called `nullgame' in
18addition to the actual game binaries. This program doesn't do
19anything; it's just a template for people to start from when adding
20a new game to the collection, and it's compiled every time to ensure
21that it _does_ compile and link successfully (because otherwise it
22wouldn't be much use as a template). Once it's built, you can run it
23if you really want to (but it's very boring), and then you should
24ignore it.
25
26DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
27back to the maintainer. The makefiles are generated automatically by
28the Perl script `mkfiles.pl' from the file `Recipe'. If you need to
29change the makefiles as part of a patch, you should change Recipe
30and/or mkfiles.pl.
e91825f8 31
32The manual, provided in Windows Help and text formats, is generated
33from a Halibut source file (puzzles.but), which is the preferred form
34for modification. To generate the manual in other formats, rebuild it,
35or learn about Halibut, visit the Halibut website at
36<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.