diff options
author | Franklin Wei <git@fwei.tk> | 2017-04-29 18:21:56 -0400 |
---|---|---|
committer | Franklin Wei <git@fwei.tk> | 2017-04-29 18:24:42 -0400 |
commit | 881746789a489fad85aae8317555f73dbe261556 (patch) | |
tree | cec2946362c4698c8db3c10f3242ef546c2c22dd /apps/plugins/puzzles/src/CHECKLST.txt | |
parent | 03dd4b92be7dcd5c8ab06da3810887060e06abd5 (diff) | |
download | rockbox-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/CHECKLST.txt')
-rw-r--r-- | apps/plugins/puzzles/src/CHECKLST.txt | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/apps/plugins/puzzles/src/CHECKLST.txt b/apps/plugins/puzzles/src/CHECKLST.txt new file mode 100644 index 0000000000..2bef909e14 --- /dev/null +++ b/apps/plugins/puzzles/src/CHECKLST.txt | |||
@@ -0,0 +1,70 @@ | |||
1 | Useful checklists | ||
2 | ================= | ||
3 | |||
4 | Things to remember when adding a new puzzle | ||
5 | ------------------------------------------- | ||
6 | |||
7 | Write the source file for the new puzzle (duhh). | ||
8 | |||
9 | Create a .R file for it which: | ||
10 | - defines a <puzzle>_EXTRA symbol for it if it requires auxiliary | ||
11 | object files (make sure that symbol doesn't contain the icon) | ||
12 | - adds it to the `ALL' definition, to ensure it is compiled into | ||
13 | the OS X binary | ||
14 | - adds it as a GTK build target, with the optional GTK icon | ||
15 | - adds it as a Windows build target, with the optional resource | ||
16 | file | ||
17 | - adds auxiliary solver binaries if any | ||
18 | - adds it to $(GAMES) in both the automake and GTK makefiles, for | ||
19 | `make install' | ||
20 | - adds it to list.c for the OS X binary | ||
21 | - adds it to gamedesc.txt, with its Windows executable name, display | ||
22 | name, and slightly longer description. | ||
23 | |||
24 | If the puzzle is by a new author, modify the copyright notice in | ||
25 | LICENCE and in puzzles.but. (Also in index.html, but that's listed | ||
26 | below under website changes.) | ||
27 | |||
28 | Double-check that the game structure name in the source file has | ||
29 | been renamed from `nullgame', so that it'll work on OS X. Actually | ||
30 | compiling it on OS X would be a good way to check this, if | ||
31 | convenient. | ||
32 | |||
33 | Add a documentation section in puzzles.but. | ||
34 | |||
35 | Make sure there's a Windows help topic name defined in puzzles.but, | ||
36 | and that it's referenced by the help topic field in the game | ||
37 | structure in the source file. | ||
38 | |||
39 | Check that REQUIRE_RBUTTON and/or REQUIRE_NUMPAD are set as | ||
40 | appropriate. | ||
41 | |||
42 | Add the new Unix binary name, and the names of any auxiliary solver | ||
43 | binaries, to .gitignore. | ||
44 | |||
45 | Write an instructions fragment for the webified puzzle pages, as | ||
46 | html/<puzzlename>.html . | ||
47 | |||
48 | Make a screenshot: | ||
49 | - create an appropriate save file in `icons' | ||
50 | - add the puzzle name to icons/Makefile | ||
51 | - set up a REDO property in icons/Makefile if the screenshot wants | ||
52 | to display a move halfway through an animation | ||
53 | - set up a CROP property in icons/Makefile if the icon wants to be | ||
54 | a sub-rectangle of the whole screenshot | ||
55 | |||
56 | Don't forget to `git add' the new source file, the new .R file and the | ||
57 | save file in `icons', the new .html file, and any other new files that | ||
58 | might have been involved. | ||
59 | |||
60 | Check in! | ||
61 | |||
62 | Put the puzzle on the web: | ||
63 | - run puzzlesnap.sh | ||
64 | - adjust the copyright in index-mid.html if the puzzle is by a new | ||
65 | author | ||
66 | - check that the new puzzle has appeared on the staging web page | ||
67 | - test both Windows binary links, the docs link, the Javascript | ||
68 | version and the Java version | ||
69 | - run webupdate | ||
70 | - test all those things once more on the live website | ||