Update 'Coding Style'

Patrick Vogler 2023-06-20 14:29:10 +00:00
parent 1a3bddaf82
commit 60625d1dbf

@ -14,8 +14,16 @@
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>
## Table of Contents
## Content
- [The Single Most Important Rule](#The_Single_Most_Important_Rule)
- [Formatting](#Formatting)
- [Line Width](#Line_Width)
- [Indentation](#Indentation)
- [Braces](#Braces)
- [Functions](#Functions)
- [Derrived Types](#Derrived_Types)
- [Comments](#Comments)
- [Syntactic Conventions](#Syntactic_Conventions)
- [Names](#Names)
- [BigWhoop Coding Style](#Abstract)
- [Abstract](#Abstract)
- [Table of Contents](#table-of-contents)
## The Single Most Important Rule