From 60625d1dbff06e9137a661885d66b5ac06512cb0 Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Tue, 20 Jun 2023 14:29:10 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/Coding-Style.md b/Coding-Style.md index 774b4b7..e581ba5 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -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

-## 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) \ No newline at end of file +## The Single Most Important Rule \ No newline at end of file