madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #413 from seregaxvm/master
[etc/awesome.git] / README.rst
1 Lain
2 ====
3
4 -------------------------------------------------
5 Layouts, widgets and utilities for Awesome WM 4.x
6 -------------------------------------------------
7
8 :Author: Luca CPZ
9 :Version: git
10 :License: GNU-GPL2_
11 :Source: https://github.com/lcpz/lain
12
13 Description
14 -----------
15
16 Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_. Read the wiki_ for all the info.
17
18 Contributions
19 -------------
20
21 Constructive criticism and suggestions are welcome.
22
23 If you want to create a pull request, make sure that:
24
25 - Your code fits with the general style of the module. In particular, you should use the same indentation pattern that the code uses, and also avoid adding space at the ends of lines.
26
27 - Your code its easy to understand, maintainable, and modularized. You should also avoid code duplication wherever possible by adding functions to or using lain.helpers_. If something is unclear, or you can't write it in such a way that it will be clear, explain it with a comment.
28
29 - You test your changes before submitting to make sure that you code works and does not break other parts of the module.
30
31 - You eventually update ``wiki`` submodule with a thorough section.
32
33 Contributed widgets have to be put in ``widget/contrib``.
34
35 .. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
36 .. _awesome-vain: https://github.com/vain/awesome-vain
37 .. _Awesome: https://github.com/awesomeWM/awesome
38 .. _wiki: https://github.com/lcpz/lain/wiki
39 .. _lain.helpers: https://github.com/lcpz/lain/blob/master/helpers.lua