| 1 | This is the README accompanying the source code to Simon Tatham's |
| 2 | puzzle collection. The collection's web site is at |
| 3 | <http://www.chiark.greenend.org.uk/~sgtatham/puzzles/>. |
| 4 | |
| 5 | If you've obtained the source code by downloading a .tar.gz archive |
| 6 | from the Puzzles web site, you should find several Makefiles in the |
| 7 | source code. However, if you've checked the source code out from the |
| 8 | Puzzles Subversion repository, you won't find the Makefiles: they're |
| 9 | automatically generated by `mkfiles.pl', so run that to create them. |
| 10 | |
| 11 | The Makefiles include: |
| 12 | |
| 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. |
| 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 | |
| 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 | |
| 28 | - `Makefile.wce' should work under MS eMbedded Visual C++ on |
| 29 | Windows and the Pocket PC SDK; it builds Pocket PC binaries. |
| 30 | |
| 31 | Many of these Makefiles build a program called `nullgame' in |
| 32 | addition to the actual game binaries. This program doesn't do |
| 33 | anything; it's just a template for people to start from when adding |
| 34 | a new game to the collection, and it's compiled every time to ensure |
| 35 | that it _does_ compile and link successfully (because otherwise it |
| 36 | wouldn't be much use as a template). Once it's built, you can run it |
| 37 | if you really want to (but it's very boring), and then you should |
| 38 | ignore it. |
| 39 | |
| 40 | DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes |
| 41 | back to the maintainer. The makefiles are generated automatically by |
| 42 | the 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, |
| 44 | you should change Recipe, *.R, and/or mkfiles.pl. |
| 45 | |
| 46 | The manual is provided in Windows Help format for the Windows build; |
| 47 | in text format for anyone who needs it; and in HTML for the Mac OS X |
| 48 | application and for the web site. It is generated from a Halibut |
| 49 | source file (puzzles.but), which is the preferred form for |
| 50 | modification. To generate the manual in other formats, rebuild it, |
| 51 | or learn about Halibut, visit the Halibut website at |
| 52 | <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>. |