summaryrefslogtreecommitdiff
path: root/apps/plugins/puzzles/src/README
diff options
context:
space:
mode:
authorFranklin Wei <git@fwei.tk>2017-04-29 18:21:56 -0400
committerFranklin Wei <git@fwei.tk>2017-04-29 18:24:42 -0400
commit881746789a489fad85aae8317555f73dbe261556 (patch)
treecec2946362c4698c8db3c10f3242ef546c2c22dd /apps/plugins/puzzles/src/README
parent03dd4b92be7dcd5c8ab06da3810887060e06abd5 (diff)
downloadrockbox-881746789a489fad85aae8317555f73dbe261556.tar.gz
rockbox-881746789a489fad85aae8317555f73dbe261556.zip
puzzles: refactor and resync with upstream
This brings puzzles up-to-date with upstream revision 2d333750272c3967cfd5cd3677572cddeaad5932, though certain changes made by me, including cursor-only Untangle and some compilation fixes remain. Upstream code has been moved to its separate subdirectory and future syncs can be done by simply copying over the new sources. Change-Id: Ia6506ca5f78c3627165ea6791d38db414ace0804
Diffstat (limited to 'apps/plugins/puzzles/src/README')
-rw-r--r--apps/plugins/puzzles/src/README54
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 @@
1This is the README accompanying the source code to Simon Tatham's
2puzzle collection. The collection's web site is at
3<http://www.chiark.greenend.org.uk/~sgtatham/puzzles/>.
4
5If you've obtained the source code by downloading a .tar.gz archive
6from the Puzzles web site, you should find several Makefiles in the
7source code. However, if you've checked the source code out from the
8Puzzles git repository, you won't find the Makefiles: they're
9automatically generated by `mkfiles.pl', so run that to create them.
10
11The 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
33Many of these Makefiles build a program called `nullgame' in
34addition to the actual game binaries. This program doesn't do
35anything; it's just a template for people to start from when adding
36a new game to the collection, and it's compiled every time to ensure
37that it _does_ compile and link successfully (because otherwise it
38wouldn't be much use as a template). Once it's built, you can run it
39if you really want to (but it's very boring), and then you should
40ignore it.
41
42DO NOT EDIT THE MAKEFILES DIRECTLY, if you plan to send any changes
43back to the maintainer. The makefiles are generated automatically by
44the 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,
46you should change Recipe, *.R, and/or mkfiles.pl.
47
48The manual is provided in Windows Help format for the Windows build;
49in text format for anyone who needs it; and in HTML for the Mac OS X
50application and for the web site. It is generated from a Halibut
51source file (puzzles.but), which is the preferred form for
52modification. To generate the manual in other formats, rebuild it,
53or learn about Halibut, visit the Halibut website at
54<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.