Stop the analysis pass in Loopy's redraw routine from being

[sgt/puzzles] / README

diff --git a/README b/README
index 1ae3e03..efa7927 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,18 @@
 This is the README accompanying the source code to Simon Tatham's
 This is the README accompanying the source code to Simon Tatham's

-puzzle collection.
+puzzle collection. The collection's web site is at
+<http://www.chiark.greenend.org.uk/~sgtatham/puzzles/>.

 
 

-You should find several Makefiles in the source code:
+If you've obtained the source code by downloading a .tar.gz archive
+from the Puzzles web site, you should find several Makefiles in the
+source code. However, if you've checked the source code out from the
+Puzzles Subversion repository, you won't find the Makefiles: they're
+automatically generated by `mkfiles.pl', so run that to create them.

 
 

- - `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.
+The Makefiles include:
+
+ - `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.
 
 
  - `Makefile.vc' should work under MS Visual C++ on Windows.
 


@@ -13,7 +20,15 @@ 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.
 
    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.
+
+ - `Makefile.wce' should work under MS eMbedded Visual C++ on
+   Windows and the Pocket PC SDK; it builds Pocket PC binaries.
+
+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
 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


@@ -24,6 +39,14 @@ ignore it.
 
 DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
 back to the maintainer. The makefiles are generated automatically by
 
 DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
 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 Perl script `mkfiles.pl' from the file `Recipe' and the various
+.R files. If you need to change the makefiles as part of a patch,
+you should change Recipe, *.R, 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
+<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.