X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/puzzles/blobdiff_plain/1cdb3e4fec4a937c7d346ac9deb795f2eb50965d..055b9cd27af52f30534c77af067a98e5ca9c4461:/README diff --git a/README b/README index 1ae3e03..6b78774 100644 --- a/README +++ b/README @@ -1,11 +1,12 @@ This is the README accompanying the source code to Simon Tatham's -puzzle collection. +puzzle collection. The collection's web site is at +. You should find several Makefiles in the source code: - - `Makefile.gtk' should work under GNU make on Linux, provided you - have GTK installed to compile and link against. It builds GTK - binaries of the puzzle games. + - `Makefile' should work under GNU make on Linux, provided you have + GTK installed to compile and link against. It builds GTK binaries + of the puzzle games. - `Makefile.vc' should work under MS Visual C++ on Windows. @@ -13,7 +14,12 @@ You should find several Makefiles in the source code: tweaks and setting of TOOLPATH, it should work for both compiling on Windows and cross-compiling on Unix. -Each of these Makefiles builds a program called `nullgame' in + - `Makefile.osx' should work under Mac OS X, provided the Xcode + tools are installed. It builds a single monolithic OS X + application capable of running any of the puzzles, or even more + than one of them at a time. + +Many of these Makefiles build a program called `nullgame' in addition to the actual game binaries. This program doesn't do anything; it's just a template for people to start from when adding a new game to the collection, and it's compiled every time to ensure @@ -27,3 +33,11 @@ back to the maintainer. The makefiles are generated automatically by the Perl script `mkfiles.pl' from the file `Recipe'. If you need to change the makefiles as part of a patch, you should change Recipe and/or mkfiles.pl. + +The manual is provided in Windows Help format for the Windows build; +in text format for anyone who needs it; and in HTML for the Mac OS X +application and for the web site. It is generated from a Halibut +source file (puzzles.but), which is the preferred form for +modification. To generate the manual in other formats, rebuild it, +or learn about Halibut, visit the Halibut website at +.