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

add a section about general code information

Browse Source
This commit is contained in:
Quinn
2025-08-12 12:05:56 +02:00
parent 37181a299c
commit 2e7932a70c
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/dev/styleref.md
View File

@@ -10,6 +10,18 @@
- clang-tidy - clang-tidy
- linux / unix-like machine - linux / unix-like machine
### code information
The project is written in the [GNU dialect](https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html) of [C99](https://www.en.cppreference.com/w/c/99.html).
Where we have dependencies on:
| library | summary |
|:----------------------------------|:--------------------------------------------------------|
| [libarchive](libarchive.org) | compression / decompression of various formats. |
| [glfw](https://www.glfw.org/) | window creation / input handling. |
| [openGL](https://www.opengl.org/) | hardware accelleration, for handling graphics. |
It is intended to be platform-agnostic, within reason. But the main focus is for [UNIX](https://unix.org/)-based systems with [x86_64](https://en.wikipedia.org/wiki/X86-64) architecture.
Within [intdef.h](/src/util/intdef.h) there live definitions for static-width integer types.
### style guide ### style guide
- Code must be written correctly, read [Correct C](./correct-c.md) if more information is required. - Code must be written correctly, read [Correct C](./correct-c.md) if more information is required.
- K&R style braces/[indentation](https://en.wikipedia.org/wiki/Indentation_style) - K&R style braces/[indentation](https://en.wikipedia.org/wiki/Indentation_style)