Add N900 Feedback list to TODO
[tennix.git] / HACKING
blob0ccd56225b87e01bce86bdac055818cf213c7ef2
1 If you want get your hands onto Tennix and improve / fix it, please have
2 a look at the TODO file first and see if there is anything that you can
3 contribute.
5 You can send patches to me; contact information is at http://thpinfo.com/about
7 Helpful hints:
8  * Adding graphics is done by adding a new constant to the "enum" block in
9    graphics.h (where GR_CURSOR, GR_BACK, etc.. are defined) - but BEFORE the
10    GR_COUNT constant (this is used to "count" how many graphcs there are);
11    after adding to graphics.h, add the filename of the desired image to the
12    same position to "static const char* graphics[]" in graphics.c (you'll get
13    the idea after comparing the variable and the enum - there's a system ;)
14  * Adding sounds is analog to adding graphics, but be sure to update the
15    LAST_SOUNDEFFECT_ID macro (it should point to the last non-voice effect
16  * Use the same coding style as the surrounding code (might be different for
17    different source files)
18  * Use C-style comments (/* ... */) and not C++-style comments (// ...)
19  * You can get a list of #defines that we currently use by running this command
20    in the source tree:          grep -hr "^#ifdef" *.c *.h | sort | uniq
21  * Global configuration and #defines should go into tennix.h; where all other
22    modules can access it
23  * You can extract the contents of a ".tnx" file by compiling the standalone
24    version of the "archive" tool and renaming it to "extract"
26 -- Thomas Perl, 2009-02-24