Update 'Coding Style'

Patrick Vogler 2023-06-20 14:14:34 +00:00
parent 0db359e502
commit e9b608deb1

@ -12,4 +12,23 @@
<p align="center">
This document discusses practices and style for programmers working on the BigWhoop compression library. The Guidelines are based on the C Coding Style recommended by the GNOME Developer Documentation and should be followed to promote a consistent, readable, and maintainable code base. The Guide offers solutions to common C, python and cmake programming issues and illustrates through examples of code
</p>
</p>
## Table of Contents
- [Recommended C style and coding rules](#recommended-c-style-and-coding-rules)
- [Table of Contents](#table-of-contents)
- [The single most important rule](#the-single-most-important-rule)
- [Integration with VSCode](#integration-with-vscode)
- [General rules](#general-rules)
- [Comments](#comments)
- [Functions](#functions)
- [Variables](#variables)
- [Structures, enumerations, typedefs](#structures-enumerations-typedefs)
- [Compound statements](#compound-statements)
- [Switch statement](#switch-statement)
- [Macros and preprocessor directives](#macros-and-preprocessor-directives)
- [Documentation](#documentation)
- [Header/source files](#headersource-files)
- [Artistic style configuration](#artistic-style-configuration)
- [Eclipse formatter](#eclipse-formatter)