v4k-git-backup/tools/docs/docs.md

Version:	{{VERSION}}
Branch:	{{GIT_BRANCH}}
Commit:	{{GIT_REVISION}}

F·W·K {{VERSION}}

a b o u t

• https://github.com/r-lyeh/FWK is a 3D game framework in C, with Luajit bindings.
• Download latest release: https://github.com/r-lyeh/FWK/releases
• WIP Documentation below. Need extra support? Join us.

Code style

```C linenumbers /// ## Markdown comments when documenting (3 slashes) // C++ comments allowed /*C comments too*/ // Order matters: includes -> defines -> enums -> structs -> functions #define puts(x) my_printf("%s", x) // lowercase defines allowed for syntax sugars #define VERSION "1.0.0" // uppercase defines otherwise enum { ZERO = 0 }; // uppercase enums. also, one-line brackets allowed void assert_positive( int my_int ) { // lowercase snake_case everywhere int *x = &my_int; // no spacing between pointers and variables if( *x < ZERO ) { // no outer padding space after if,do,while,for,switch puts( "Negative" ); // inner padding space around operators and parenthesis } // 4-spaces indents, 1TBS brackets } // when in doubt, dont worry & mimic style from codebase ```

r e a d m e