Style Guide
===========

+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type                   | Value                                                                                                                                                                                           |
+========================+=================================================================================================================================================================================================+
| Line Length            | 80                                                                                                                                                                                              |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Character Encoding     | UTF-8                                                                                                                                                                                           |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Line Break             | LineFeed ``\n``                                                                                                                                                                                 |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Tabs                   | 4 Spaces (exept ``Makefile``\ s)                                                                                                                                                                |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Brackets               | Egyptian Brackets / K&R Style                                                                                                                                                                   |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Naming Convention      | Depends on the programming language (`Python <https://google.github.io/styleguide/pyguide.html?showone=Naming#Naming>`__, `C++ <https://google.github.io/styleguide/cppguide.html#Naming>`__)   |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| File Name Convention   | ``under_score.log``                                                                                                                                                                             |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Comments / Documentation
------------------------

-  Insert describing comment at:

   -  File header (describe the content of the file)
   -  Fields (describe the public variables)
   -  Methods/Functions (describe public functions and functions of
      special interest)

Links
-----

-  Brackets: Read *3. Egyptian Brackets* at
   https://blog.codinghorror.com/new-programming-jargon/
-  Google Style Guides for:

   -  C++: https://google.github.io/styleguide/cppguide.html
   -  Python: https://google.github.io/styleguide/pyguide.html

-  Python PEP8: https://www.python.org/dev/peps/pep-0008/