README.rst

   1 Lain
   2 ====
   3
   4 ---------------------------------------------
   5 Layouts, widgets and utilities for Awesome WM
   6 ---------------------------------------------
   7
   8 :Author: Luke Bonham <dada [at] archlinux [dot] info>
   9 :Version: git
  10 :License: GNU-GPLv2_
  11 :Source: https://github.com/copycat-killer/lain
  12
  13 Description
  14 -----------
  15
  16 Successor of awesome-vain_, this module provides new layouts, a set of widgets and utility functions, in order to improve Awesome_ usability and configurability.
  17
  18 Read the wiki_ for all the info.
  19
  20 Contributions
  21 -------------
  22
  23 Any contribution is welcome! Feel free to make a pull request.
  24
  25 Just make sure that:
  26
  27 - 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.
  28
  29 - Your code its easy to understand, maintainable, and modularized. You should also avoid code duplication wherever possible by adding functions or using ``lain.helpers``. If something is unclear, and you can't write it in such a way that it will be clear, explain it with a comment.
  30
  31 - You test your changes before submitting to make sure that not only your code works, but did not break other parts of the module too!
  32
  33 - You eventually update ``wiki`` submodule with a thorough section.
  34
  35 Contributed widgets have to be put in ``lain/widget/contrib``.
  36
  37 Screenshots
  38 -----------
  39
  40 .. image:: http://i.imgur.com/8D9A7lW.png
  41 .. image:: http://i.imgur.com/9Iv3OR3.png
  42 .. image:: http://i.imgur.com/STCPcaJ.png
  43
  44 .. _GNU-GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
  45 .. _awesome-vain: https://github.com/vain/awesome-vain
  46 .. _Awesome: http://awesome.naquadah.org/
  47 .. _wiki: https://github.com/copycat-killer/lain/wiki