[sgt/puzzles] / CHECKLST.txt

Useful checklists
=================

Things to remember when adding a new puzzle
-------------------------------------------

Write the source file for the new puzzle (duhh).

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.

If the puzzle is by a new author, modify the copyright notice in
LICENCE and in puzzles.but. (Also in index.html, but that's listed
below under website changes.)

Add it to list.c so that the OS X binary will be able to select it
from the menus. (Also, double-check that the game structure name in
the source file has been renamed from `nullgame'. Actually compiling
it on OS X would be a good way to check this, if convenient.)

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
 - adjust the copyright in index.html if the puzzle is by a new
   author
 - 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)
Commit	Line	Data
1b470bcf	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
1b470bcf	9	Add 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
6193da8d	15	If the puzzle is by a new author, modify the copyright notice in
	16	LICENCE and in puzzles.but. (Also in index.html, but that's listed
	17	below under website changes.)
	18
1b470bcf	19	Add it to list.c so that the OS X binary will be able to select it
7f34e0ed	20	from the menus. (Also, double-check that the game structure name in
	21	the source file has been renamed from `nullgame'. Actually compiling
	22	it on OS X would be a good way to check this, if convenient.)
1b470bcf	23
	24	Add a documentation section in puzzles.but.
	25
	26	Make sure there's a Windows help topic name defined in puzzles.but,
	27	and that it's referenced by the help topic field in the game
	28	structure in the source file.
	29
	30	Add the new Unix binary name to the svn:ignore property.
	31
	32	Don't forget to `svn add' the new source file before checkin!
	33
	34	Put the puzzle on the web:
	35	- make a screenshot
	36	- add an entry in the puzzles list in index.html
6193da8d	37	- adjust the copyright in index.html if the puzzle is by a new
6193da8d	38	author
1b470bcf	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)