Stop the analysis pass in Loopy's redraw routine from being
[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
cec8bfaf 5If you've obtained the source code by downloading a .tar.gz archive
6from the Puzzles web site, you should find several Makefiles in the
7source code. However, if you've checked the source code out from the
8Puzzles Subversion repository, you won't find the Makefiles: they're
9automatically generated by `mkfiles.pl', so run that to create them.
10
11The Makefiles include:
1cdb3e4f 12
8d79d5d9 13 - `Makefile' should work under GNU make on Linux, provided you have
14 GTK installed to compile and link against. It builds GTK binaries
15 of the puzzle games.
1cdb3e4f 16
17 - `Makefile.vc' should work under MS Visual C++ on Windows.
18
19 - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate
20 tweaks and setting of TOOLPATH, it should work for both compiling
21 on Windows and cross-compiling on Unix.
22
8a771ea7 23 - `Makefile.osx' should work under Mac OS X, provided the Xcode
24 tools are installed. It builds a single monolithic OS X
25 application capable of running any of the puzzles, or even more
26 than one of them at a time.
27
cec8bfaf 28 - `Makefile.wce' should work under MS eMbedded Visual C++ on
29 Windows and the Pocket PC SDK; it builds Pocket PC binaries.
30
8a771ea7 31Many of these Makefiles build a program called `nullgame' in
1cdb3e4f 32addition to the actual game binaries. This program doesn't do
33anything; it's just a template for people to start from when adding
34a new game to the collection, and it's compiled every time to ensure
35that it _does_ compile and link successfully (because otherwise it
36wouldn't be much use as a template). Once it's built, you can run it
37if you really want to (but it's very boring), and then you should
38ignore it.
39
40DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
41back to the maintainer. The makefiles are generated automatically by
cec8bfaf 42the Perl script `mkfiles.pl' from the file `Recipe' and the various
43.R files. If you need to change the makefiles as part of a patch,
44you should change Recipe, *.R, and/or mkfiles.pl.
e91825f8 45
8a771ea7 46The manual is provided in Windows Help format for the Windows build;
47in text format for anyone who needs it; and in HTML for the Mac OS X
48application and for the web site. It is generated from a Halibut
49source file (puzzles.but), which is the preferred form for
50modification. To generate the manual in other formats, rebuild it,
e91825f8 51or learn about Halibut, visit the Halibut website at
52<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.