Missing uses of \q{}.
[sgt/puzzles] / CHECKLST.txt
CommitLineData
1b470bcf 1Useful checklists
2=================
3
4Things to remember when adding a new puzzle
5-------------------------------------------
6
7Write the source file for the new puzzle (duhh).
8
3f98cd5a 9Create a .R file for it which:
10 - defines a Recipe symbol for it if it requires auxiliary object
11 files
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
15 - adds it as a Windows build target
16 - adds auxiliary solver binaries if any
17 - adds it to $(GAMES) in the GTK makefile, for `make install'
18 - adds it to list.c for the OS X binary.
1b470bcf 19
6193da8d 20If the puzzle is by a new author, modify the copyright notice in
21LICENCE and in puzzles.but. (Also in index.html, but that's listed
22below under website changes.)
23
3f98cd5a 24Double-check that the game structure name in the source file has
25been renamed from `nullgame', so that it'll work on OS X. Actually
26compiling it on OS X would be a good way to check this, if
27convenient.
1b470bcf 28
29Add a documentation section in puzzles.but.
30
31Make sure there's a Windows help topic name defined in puzzles.but,
32and that it's referenced by the help topic field in the game
33structure in the source file.
34
35Add the new Unix binary name to the svn:ignore property.
36
afc306fc 37Make a screenshot:
38 - create an appropriate save file in `icons'
39 - add the puzzle name to icons/Makefile
40 - set up a REDO property in icons/Makefile if desired
41
42Don't forget to `svn add' the new source file, the new .R file and
43the save file in `icons', before checkin!
1b470bcf 44
45Put the puzzle on the web:
fac5dd27 46 - run puzzlesnap first
47 - make sure the screenshot has arrived in the www directory
48 - make sure the Windows binary link has appeared, and that it
49 points at the right binary
1b470bcf 50 - add an entry in the puzzles list in index.html
6193da8d 51 - adjust the copyright in index.html if the puzzle is by a new
52 author
1b470bcf 53 - test that the binary link and the docs link work
54 - run webupdate
55 - test again
fac5dd27 56 - `svn add' the binary symlink
57 - check in the website changes (symlink, index.html)