Extra utility function.
[sgt/puzzles] / CHECKLST.txt
... / ...
CommitLineData
1Useful checklists
2=================
3
4Things to remember when adding a new puzzle
5-------------------------------------------
6
7Write the source file for the new puzzle (duhh).
8
9Add it to Recipe in _four_ places:
10 - the `ALL' definition, to ensure it is compiled into the OS X binary
11 - as a GTK build target
12 - as a Windows build target
13 - in the Unix `make install' section at the bottom.
14
15If the puzzle is by a new author, modify the copyright notice in
16LICENCE and in puzzles.but. (Also in index.html, but that's listed
17below under website changes.)
18
19Add it to list.c so that the OS X binary will be able to select it
20from the menus. (Also, double-check that the game structure name in
21the source file has been renamed from `nullgame'. Actually compiling
22it on OS X would be a good way to check this, if convenient.)
23
24Add a documentation section in puzzles.but.
25
26Make sure there's a Windows help topic name defined in puzzles.but,
27and that it's referenced by the help topic field in the game
28structure in the source file.
29
30Add the new Unix binary name to the svn:ignore property.
31
32Don't forget to `svn add' the new source file before checkin!
33
34Put the puzzle on the web:
35 - make a screenshot
36 - add an entry in the puzzles list in index.html
37 - adjust the copyright in index.html if the puzzle is by a new
38 author
39 - add a link to the Windows binary
40 - make sure the Windows binary link points at the right binary, not
41 the wrong one!
42 - run puzzlesnap
43 - test that the binary link and the docs link work
44 - run webupdate
45 - test again
46 - `svn add' the binary symlink and the screenshot
47 - check in the website changes (screenshot, symlink, index.html)