stk-code_catmod/doc/conventions.txt
grumbel 7a6d165641 - moved trunk/ to trunk/supertuxkart
git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/trunk/supertuxkart@1118 178a84e3-b1eb-0310-8ba1-8eac791a3b58
2007-05-27 16:01:53 +00:00

26 lines
803 B
Plaintext

Here are the guidelines to follow when coding Super Tux Kart:
Filenames
=========
The filenames should be, with underscores between words. Use the .cpp
extension for C++ implementation files and .hpp for C++ headers, .c for
C files and .h for C headers.
Coding style
============
The coding style used in Super Tux Kart can be found at
http://supertuxkart.berlios.de/wiki/index.php/Coding_Style .
Documentation line length
=========================
All the documentation files should have at most 75 characters, because
on some displays and on paper you often are limited to 80 characters, and
also under some conditions appendices (for example, line numbers) are
added. The exception if the player's manual, because it's long, so to
understand it better it should be limited to 65 characters.