X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=CHECKLST.txt;h=2bef909e14bdce36fa96b88066679bc8203bb096;hb=3234912f921916a1b8da164fd61dc75579358577;hp=9d6800937769df5d8ec835ce403971149da4b9e2;hpb=ca6950b0f7f7ccb3b8f86673a3626e1b4122bbb0;p=sgt-puzzles.git diff --git a/CHECKLST.txt b/CHECKLST.txt index 9d68009..2bef909 100644 --- a/CHECKLST.txt +++ b/CHECKLST.txt @@ -6,18 +6,29 @@ 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. +Create a .R file for it which: + - defines a _EXTRA symbol for it if it requires auxiliary + object files (make sure that symbol doesn't contain the icon) + - adds it to the `ALL' definition, to ensure it is compiled into + the OS X binary + - adds it as a GTK build target, with the optional GTK icon + - adds it as a Windows build target, with the optional resource + file + - adds auxiliary solver binaries if any + - adds it to $(GAMES) in both the automake and GTK makefiles, for + `make install' + - adds it to list.c for the OS X binary + - adds it to gamedesc.txt, with its Windows executable name, display + name, and slightly longer description. -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.) +Double-check that the game structure name in the source file has +been renamed from `nullgame', so that it'll work on OS X. Actually +compiling it on OS X would be a good way to check this, if +convenient. Add a documentation section in puzzles.but. @@ -25,19 +36,35 @@ 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. +Check that REQUIRE_RBUTTON and/or REQUIRE_NUMPAD are set as +appropriate. -Don't forget to `svn add' the new source file before checkin! +Add the new Unix binary name, and the names of any auxiliary solver +binaries, to .gitignore. + +Write an instructions fragment for the webified puzzle pages, as +html/.html . + +Make a screenshot: + - create an appropriate save file in `icons' + - add the puzzle name to icons/Makefile + - set up a REDO property in icons/Makefile if the screenshot wants + to display a move halfway through an animation + - set up a CROP property in icons/Makefile if the icon wants to be + a sub-rectangle of the whole screenshot + +Don't forget to `git add' the new source file, the new .R file and the +save file in `icons', the new .html file, and any other new files that +might have been involved. + +Check in! 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 puzzlesnap.sh + - adjust the copyright in index-mid.html if the puzzle is by a new + author + - check that the new puzzle has appeared on the staging web page + - test both Windows binary links, the docs link, the Javascript + version and the Java version - run webupdate - - test again - - `svn add' the binary symlink and the screenshot - - check in the website changes (screenshot, symlink, index.html) + - test all those things once more on the live website