mdw@git.distorted.org.uk Git - sgt/puzzles/blob - CHECKLST.txt

   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
   9 Create 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
  19  - adds it to wingames.lst along with a textual name, for the build
  20    system and Windows installer.
  21
  22 If the puzzle is by a new author, modify the copyright notice in
  23 LICENCE and in puzzles.but. (Also in index.html, but that's listed
  24 below under website changes.)
  25
  26 Double-check that the game structure name in the source file has
  27 been renamed from `nullgame', so that it'll work on OS X. Actually
  28 compiling it on OS X would be a good way to check this, if
  29 convenient.
  30
  31 Add a documentation section in puzzles.but.
  32
  33 Make sure there's a Windows help topic name defined in puzzles.but,
  34 and that it's referenced by the help topic field in the game
  35 structure in the source file.
  36
  37 Add the new Unix binary name, and the names of any auxiliary solver
  38 binaries, to the svn:ignore property.
  39
  40 Make a screenshot:
  41  - create an appropriate save file in `icons'
  42  - add the puzzle name to icons/Makefile
  43  - set up a REDO property in icons/Makefile if desired
  44
  45 Don't forget to `svn add' the new source file, the new .R file and
  46 the save file in `icons', and any other new files that might have
  47 been involved.
  48
  49 Check in!
  50
  51 Put the puzzle on the web:
  52  - run puzzlesnap first
  53  - make sure the screenshot and Windows binary have arrived in the
  54    www directory
  55  - add an entry in the puzzles list in index.html
  56  - adjust the copyright in index.html if the puzzle is by a new
  57    author
  58  - test that the binary link and the docs link work
  59  - run webupdate
  60  - test again
  61  - check in the change to index.html