From 66b34b1afc946fa0554473c237db7430c159c924 Mon Sep 17 00:00:00 2001 From: VoidAtValhalla Date: Tue, 18 Mar 2014 20:56:04 +0100 Subject: [PATCH] Add project guidelines --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 2dc6cf7..2cc4c72 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,14 @@ Dynamic menu library and client program inspired by dmenu * [GNU GPLv3 (or any later version)](LICENSE-CLIENT) for client program[s] and other sources except library and bindings * [GNU LGPLv3 (or any later version)](LICENSE-LIB) for library and bindings + +## Project Guidelines +* **Coding style** + * [Linux kernel coding style](https://www.kernel.org/doc/Documentation/CodingStyle) + for C sources with following exceptions: + * spaces not tabs + * indentation size is 4 characters (spaces) + * [Standard style](http://legacy.python.org/dev/peps/pep-0008/) for Python +* **Build system** - [CMake](http://www.cmake.org/) +* **API documentation** - [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html) + (JavaDoc style comments)