diff options
Diffstat (limited to 'apps/plugins/puzzles/src/README')
-rw-r--r-- | apps/plugins/puzzles/src/README | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/apps/plugins/puzzles/src/README b/apps/plugins/puzzles/src/README new file mode 100644 index 0000000000..890db56771 --- /dev/null +++ b/apps/plugins/puzzles/src/README | |||
@@ -0,0 +1,54 @@ | |||
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 | If you've obtained the source code by downloading a .tar.gz archive | ||
6 | from the Puzzles web site, you should find several Makefiles in the | ||
7 | source code. However, if you've checked the source code out from the | ||
8 | Puzzles git repository, you won't find the Makefiles: they're | ||
9 | automatically generated by `mkfiles.pl', so run that to create them. | ||
10 | |||
11 | The Makefiles include: | ||
12 | |||
13 | - `Makefile.am', together with the static `configure.ac', is intended | ||
14 | as input to automake. Run `mkauto.sh' to turn these into a | ||
15 | configure script and Makefile.in, after which you can then run | ||
16 | `./configure' to create an actual Unix Makefile. | ||
17 | |||
18 | - `Makefile.vc' should work under MS Visual C++ on Windows. Run | ||
19 | 'nmake /f Makefile.vc' in a Visual Studio command prompt. | ||
20 | |||
21 | - `Makefile.cyg' should work under Cygwin / MinGW. With appropriate | ||
22 | tweaks and setting of TOOLPATH, it should work for both compiling | ||
23 | on Windows and cross-compiling on Unix. | ||
24 | |||
25 | - `Makefile.osx' should work under Mac OS X, provided the Xcode | ||
26 | tools are installed. It builds a single monolithic OS X | ||
27 | application capable of running any of the puzzles, or even more | ||
28 | than one of them at a time. | ||
29 | |||
30 | - `Makefile.wce' should work under MS eMbedded Visual C++ on | ||
31 | Windows and the Pocket PC SDK; it builds Pocket PC binaries. | ||
32 | |||
33 | Many of these Makefiles build a program called `nullgame' in | ||
34 | addition to the actual game binaries. This program doesn't do | ||
35 | anything; it's just a template for people to start from when adding | ||
36 | a new game to the collection, and it's compiled every time to ensure | ||
37 | that it _does_ compile and link successfully (because otherwise it | ||
38 | wouldn't be much use as a template). Once it's built, you can run it | ||
39 | if you really want to (but it's very boring), and then you should | ||
40 | ignore it. | ||
41 | |||
42 | DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes | ||
43 | back to the maintainer. The makefiles are generated automatically by | ||
44 | the Perl script `mkfiles.pl' from the file `Recipe' and the various | ||
45 | .R files. If you need to change the makefiles as part of a patch, | ||
46 | you should change Recipe, *.R, and/or mkfiles.pl. | ||
47 | |||
48 | The manual is provided in Windows Help format for the Windows build; | ||
49 | in text format for anyone who needs it; and in HTML for the Mac OS X | ||
50 | application and for the web site. It is generated from a Halibut | ||
51 | source file (puzzles.but), which is the preferred form for | ||
52 | modification. To generate the manual in other formats, rebuild it, | ||
53 | or learn about Halibut, visit the Halibut website at | ||
54 | <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>. | ||