summary refs log tree commit diff
path: root/C-STYLE.md
diff options
context:
space:
mode:
authorChristian Neukirchen <chneukirchen@gmail.com>2016-09-07 17:14:39 +0200
committerChristian Neukirchen <chneukirchen@gmail.com>2016-09-07 17:14:39 +0200
commitffb7fcc857a3c11d8baf00165134d0612c8bb48f (patch)
tree5320e9a86468791642d8826fbd87d3861dc3e2fd /C-STYLE.md
parent1d82b162685e9b0d122aa613e76477eb8a744122 (diff)
downloadstyleguide-ffb7fcc857a3c11d8baf00165134d0612c8bb48f.tar.gz
styleguide-ffb7fcc857a3c11d8baf00165134d0612c8bb48f.tar.xz
styleguide-ffb7fcc857a3c11d8baf00165134d0612c8bb48f.zip
C-STYLE: use Markdown headers
Diffstat (limited to 'C-STYLE.md')
-rw-r--r--C-STYLE.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/C-STYLE.md b/C-STYLE.md
index 309a652..24a4396 100644
--- a/C-STYLE.md
+++ b/C-STYLE.md
@@ -1,4 +1,4 @@
-= Christian Neukirchen's C Style Guide
+# Christian Neukirchen's C Style Guide
 
 You may not like all rules presented here, but they work very well for
 me and have helped producing high quality code.  Everyone is free to
@@ -8,7 +8,7 @@ when you contribute to my code, please follow these rules:
 This guide does not explain how to write good C code,
 but merely how to format it.
 
-== Formatting:
+## Formatting:
 
 * Use ASCII (UTF-8 is ok in comments, if you have to).
 
@@ -104,7 +104,7 @@ but merely how to format it.
 
 * Declare functions `static` when they are only used in this translation unit.
 
-== Idioms:
+## Idioms:
 
 * Using the return value of `=` is ok.
 
@@ -142,7 +142,7 @@ but merely how to format it.
 * Avoid forward declarations unless indispensable.
   Let `main` be the last function in code.
 
-== Naming:
+## Naming:
 
 * The length of an identifier determines its scope.
 
@@ -159,7 +159,7 @@ but merely how to format it.
 
 * Use a consistent prefix for all global names in a library.
 
-== Comments:
+## Comments:
 
 * Comments longer than a word are capitalized and use punctuation.
   Use two spaces after periods.
@@ -184,13 +184,13 @@ but merely how to format it.
 
 * Avoid superfluous comments.
 
-== The rest:
+## The rest:
 
 * Avoid long functions.
 
 * Avoid long parameter lists.
 
-== General:
+## General:
 
 * Do not mutate arguments unless that is the purpose of the function.