Updated to include tests for Gentoo installation
[crack-attack.git] / doc / ready_to_release
blob0863e1dd6aeb967fd4c3946df322d8269a489795
1 == Criteria for Release ==
3 Let's not repeat the mistakes of the past. This file will be used to accumulate advice and methods to fix common release errors before the release. Nothing in this project should be released if it hasn't been through at least the scrutiny outlined in this file.
5 == Target Architectures ==
7 x86, amd64
9 == Compiling ==
11 Ensure that the program compiles as-is with whichever compiler is stable for our target architectures. There shouldn't be any warnings, and C[XX]FLAGS passed in to the configure script should be the primary flags used in the compilation.
13 == Installing ==
15 make install <em>must</em> obey PREFIX! Potentially use a chroot to ensure that no files end up anywhere they shouldn't be. 
17 Any autopackage files should be tested to ensure that all of the files that are installed are removed on uninstall.
19 == Smoketests ==
21 Ensure the game runs as expected from the install chroot using FreeGLUT.
23 Note: The following tests should be performed without using any low graphics settings
25 Play a single-player game to completion versus yourself.
27 Play a single-player game to completion versus the computer player.
29 Play a multi-player game with the current version, and the earliest version that this is expected to be compatible with and the most recent version.
31 Make sure there isn't any debugging output when DEVELOPMENT isn't defined.
33 == Compatibility ==
35 Check that the networking version number is compatible with all versions that share this number.