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 Each of these Makefiles builds a program called `nullgame' in
  18 addition to the actual game binaries. This program doesn't do
  19 anything; it's just a template for people to start from when adding
  20 a new game to the collection, and it's compiled every time to ensure
  21 that it _does_ compile and link successfully (because otherwise it
  22 wouldn't be much use as a template). Once it's built, you can run it
  23 if you really want to (but it's very boring), and then you should
  24 ignore it.
  25
  26 DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
  27 back to the maintainer. The makefiles are generated automatically by
  28 the Perl script `mkfiles.pl' from the file `Recipe'. If you need to
  29 change the makefiles as part of a patch, you should change Recipe
  30 and/or mkfiles.pl.
  31
  32 The manual, provided in Windows Help and text formats, is generated
  33 from a Halibut source file (puzzles.but), which is the preferred form
  34 for modification. To generate the manual in other formats, rebuild it,
  35 or learn about Halibut, visit the Halibut website at
  36 <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.