Amend README so that it makes reasonable sense no matter whether

you've got your source code from a tarball (with makefiles) or from
svn (without makefiles). While I'm here, mention Makefile.wce.

[originally from svn r7352]
This commit is contained in:
Simon Tatham
2007-03-01 13:29:53 +00:00
parent db743e54e8
commit 2fc204c1e2

17
README
View File

@ -2,7 +2,13 @@ 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/>.
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.
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
@ -19,6 +25,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.
- `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
@ -30,9 +39,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
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