mdw@git.distorted.org.uk Git - sgt/puzzles/blob - README

   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 You should find several Makefiles in the source code:
   6
   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.
  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
  17  - `Makefile.osx' should work under Mac OS X, provided the Xcode
  18    tools are installed. It builds a single monolithic OS X
  19    application capable of running any of the puzzles, or even more
  20    than one of them at a time.
  21
  22 Many of these Makefiles build a program called `nullgame' in
  23 addition to the actual game binaries. This program doesn't do
  24 anything; it's just a template for people to start from when adding
  25 a new game to the collection, and it's compiled every time to ensure
  26 that it _does_ compile and link successfully (because otherwise it
  27 wouldn't be much use as a template). Once it's built, you can run it
  28 if you really want to (but it's very boring), and then you should
  29 ignore it.
  30
  31 DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
  32 back to the maintainer. The makefiles are generated automatically by
  33 the Perl script `mkfiles.pl' from the file `Recipe'. If you need to
  34 change the makefiles as part of a patch, you should change Recipe
  35 and/or mkfiles.pl.
  36
  37 The manual is provided in Windows Help format for the Windows build;
  38 in text format for anyone who needs it; and in HTML for the Mac OS X
  39 application and for the web site. It is generated from a Halibut
  40 source file (puzzles.but), which is the preferred form for
  41 modification. To generate the manual in other formats, rebuild it,
  42 or learn about Halibut, visit the Halibut website at
  43 <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.