chiark / gitweb /
Forbid undo of new-game if it would change the params.
[sgt-puzzles.git] / README
diff --git a/README b/README
index 6b78774b0dec280f328f805fd474168c86cdc49f..00830126e85a7f62775f28596a3bf272563ae240 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,22 @@
 This is the README accompanying the source code to Simon Tatham's
 puzzle collection. The collection's web site is at
 This is the README accompanying the source code to Simon Tatham's
 puzzle collection. The collection's web site is at
-<http://www.chiark.greenend.org.uk/~sgtatham/puzzles/>.
+<https://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 git repository, you won't find the Makefiles: they're
+automatically generated by `mkfiles.pl', so run that to create them.
 
 
- - `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.
+The Makefiles include:
 
 
- - `Makefile.vc' should work under MS Visual C++ on Windows.
+ - `Makefile.am', together with the static `configure.ac', is intended
+   as input to automake. Run `mkauto.sh' to turn these into a
+   configure script and Makefile.in, after which you can then run
+   `./configure' to create an actual Unix Makefile.
+
+ - `Makefile.vc' should work under MS Visual C++ on Windows. Run
+   'nmake /f Makefile.vc' in a Visual Studio command prompt.
 
  - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate
    tweaks and setting of TOOLPATH, it should work for both compiling
 
  - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate
    tweaks and setting of TOOLPATH, it should work for both compiling
@@ -19,6 +27,9 @@ You should find several Makefiles in the source code:
    application capable of running any of the puzzles, or even more
    than one of them at a time.
 
    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
 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
@@ -30,9 +41,9 @@ 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
 
 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
@@ -40,4 +51,4 @@ 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
 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/>.
+<https://www.chiark.greenend.org.uk/~sgtatham/halibut/>.