Update 'Coding Style'

Patrick Vogler 2023-06-20 14:12:24 +00:00
parent 1c23eca71e
commit 33b3067da0

@ -1 +1,15 @@
Welcome to the Coding Style.
<p align="center">
<img width="400" src="https://code.hlrs.de/hpcpvogl/BigWhoop/raw/branch/main/docs/img/Heading.png" alt="BigWhoop Document Headline">
</p>
<h1 align="center">
Coding Style
</h1>
<h3 align="center">
Abstract
</h3>
<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>