thepigeongenerator/mcaselector-lite
1
0
Fork 0
mirror of https://github.com/thepigeongenerator/mcaselector-lite.git synced 2025-12-17 06:05:44 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
2e7932a70c22b15469ffbf598ba6f58cdface46c
mcaselector-lite/docs/dev/styleref.md

1.8 KiB
Raw Blame History

mcaselector-lite style reference

contents

recommended tools

  • gcc
  • git (duh)
  • clang-format
  • clang-tidy
  • linux / unix-like machine

code information

The project is written in the GNU dialect of C99. Where we have dependencies on:

library summary
libarchive compression / decompression of various formats.
glfw window creation / input handling.
openGL hardware accelleration, for handling graphics.

It is intended to be platform-agnostic, within reason. But the main focus is for UNIX-based systems with x86_64 architecture. Within intdef.h there live definitions for static-width integer types.

style guide

  • Code must be written correctly, read Correct C if more information is required.
  • K&R style braces/indentation
  • typedefs are discouraged
  • snake_case is used for all user-defined symbols. Macros are often all-uppercase, same goes for enums and other types of compile-time constants.
  • tabs are used for indentation, spaces are used for alignment.
  • British spelling is (generally) preferred, but not enforced.
  • commits should attempt to convey clearly what is being changed, for the sanity of the maintainer(s).