chiark / gitweb /
I keep forgetting to do things when adding a new puzzle, so here's a
authorSimon Tatham <anakin@pobox.com>
Sun, 17 Jul 2005 09:35:01 +0000 (09:35 +0000)
committerSimon Tatham <anakin@pobox.com>
Sun, 17 Jul 2005 09:35:01 +0000 (09:35 +0000)
checklist.

[originally from svn r6103]

CHECKLST.txt [new file with mode: 0644]

diff --git a/CHECKLST.txt b/CHECKLST.txt
new file mode 100644 (file)
index 0000000..8d24866
--- /dev/null
@@ -0,0 +1,41 @@
+Useful checklists
+=================
+
+Things to remember when adding a new puzzle
+-------------------------------------------
+
+Write the source file for the new puzzle (duhh).
+
+Write a section in print.py, if applicable.
+
+Add it to Recipe in _four_ places:
+ - the `ALL' definition, to ensure it is compiled into the OS X binary
+ - as a GTK build target
+ - as a Windows build target
+ - in the Unix `make install' section at the bottom.
+
+Add it to list.c so that the OS X binary will be able to select it
+from the menus.
+
+Add a documentation section in puzzles.but.
+
+Make sure there's a Windows help topic name defined in puzzles.but,
+and that it's referenced by the help topic field in the game
+structure in the source file.
+
+Add the new Unix binary name to the svn:ignore property.
+
+Don't forget to `svn add' the new source file before checkin!
+
+Put the puzzle on the web:
+ - make a screenshot
+ - add an entry in the puzzles list in index.html
+ - add a link to the Windows binary
+ - make sure the Windows binary link points at the right binary, not
+   the wrong one!
+ - run puzzlesnap
+ - test that the binary link and the docs link work
+ - run webupdate
+ - test again
+ - `svn add' the binary symlink and the screenshot
+ - check in the website changes (screenshot, symlink, index.html)