2017-11-04 15:12:45 +00:00
|
|
|
Introduction
|
|
|
|
|
============
|
|
|
|
|
|
2017-01-01 19:57:30 +00:00
|
|
|
This is the readme for the Rockbox port of Simon Tatham's Portable
|
|
|
|
|
Puzzle Collection.
|
|
|
|
|
|
2017-11-04 15:12:45 +00:00
|
|
|
The upstream version used is subject to change, as it should be
|
|
|
|
|
relatively trivial to update it to a newer version. Simply copying the
|
|
|
|
|
upstream repo's contents into src/ and running genhelp.sh ought to do
|
|
|
|
|
it (watch out for API changes, though!).
|
|
|
|
|
|
|
|
|
|
Source structure
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
Most of the upstream files in src/ are essentially untouched, apart
|
|
|
|
|
from some minor adjustments to make them compile and run happily on
|
|
|
|
|
Rockbox. The majority of the rockbox-specific code is found in
|
|
|
|
|
rockbox.c, with some minor stuff in rbwrappers.c and rbmalloc.c.
|
2017-01-01 19:57:30 +00:00
|
|
|
|
2017-11-04 15:12:45 +00:00
|
|
|
Help feature
|
|
|
|
|
============
|
2017-01-01 19:57:30 +00:00
|
|
|
|
2017-11-04 15:12:45 +00:00
|
|
|
The Help feature is implemented by compiling each puzzle against a
|
|
|
|
|
compressed version of each puzzle's section from the upstream
|
|
|
|
|
documentation. These files are stored under help/, and are generated
|
|
|
|
|
by genhelp.sh from the puzzles.but file in the source
|
|
|
|
|
distribution. The compression is LZ4, implemented in lz4tiny.c (for
|
|
|
|
|
decompression on target), and compress.c (for generation). genhelp.sh
|
|
|
|
|
should be run whenever the documentation is chagned.
|
2017-01-01 19:57:30 +00:00
|
|
|
|
|
|
|
|
Kudos to Simon (duh), and Frank, for telling me about it.
|
|
|
|
|
|
|
|
|
|
Franklin Wei (__builtin)
|
2017-04-29 22:21:56 +00:00
|
|
|
|
2017-11-04 15:12:45 +00:00
|
|
|
Changelog
|
|
|
|
|
=========
|
|
|
|
|
|
2017-04-29 22:21:56 +00:00
|
|
|
April 2017: Changes made to move upstream sources to a separate
|
|
|
|
|
subdirectory, where they are completely unmodified from the
|
|
|
|
|
original. Updating the upstream version is now as simple as copying a
|
|
|
|
|
fresh set of sources to src/. Several hacks were used to accomplish
|
|
|
|
|
this: a global include specified on the command line, and a directory
|
|
|
|
|
of dummy header files.
|
2017-08-16 15:39:34 +00:00
|
|
|
|
|
|
|
|
August 2017: Every game that can be played with only the cursor keys
|
|
|
|
|
is now functional.
|
2017-11-04 15:12:45 +00:00
|
|
|
|
|
|
|
|
October 2017: Added zoom feature.
|
