diff options
| author | VoidAtValhalla <VoidAtValhalla@users.noreply.github.com> | 2014-03-18 20:56:04 +0100 |
|---|---|---|
| committer | VoidAtValhalla <VoidAtValhalla@users.noreply.github.com> | 2014-03-18 20:56:04 +0100 |
| commit | 66b34b1afc946fa0554473c237db7430c159c924 (patch) | |
| tree | 3bf07700d6e0092ce52598d3ce21c0b1f6f1d03f /README.md | |
| parent | d8e14d364c56186c31a5a45708bf05cca98d1273 (diff) | |
| download | bemenu-66b34b1afc946fa0554473c237db7430c159c924.tar.gz bemenu-66b34b1afc946fa0554473c237db7430c159c924.tar.bz2 bemenu-66b34b1afc946fa0554473c237db7430c159c924.zip | |
Add project guidelines
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -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) |