summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVoidAtValhalla <VoidAtValhalla@users.noreply.github.com>2014-03-18 20:56:36 +0100
committerVoidAtValhalla <VoidAtValhalla@users.noreply.github.com>2014-03-18 20:56:36 +0100
commit1dd0ea1d4c1aa93fe5efd96e4818babd778289d6 (patch)
tree3bf07700d6e0092ce52598d3ce21c0b1f6f1d03f
parentd8e14d364c56186c31a5a45708bf05cca98d1273 (diff)
parent66b34b1afc946fa0554473c237db7430c159c924 (diff)
downloadbemenu-1dd0ea1d4c1aa93fe5efd96e4818babd778289d6.tar.gz
bemenu-1dd0ea1d4c1aa93fe5efd96e4818babd778289d6.tar.bz2
bemenu-1dd0ea1d4c1aa93fe5efd96e4818babd778289d6.zip
Merge branch 'dev/readme' into develop
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
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)