README.rst

   1 Lain
   2 ====
   3
   4 -------------------------------------------------
   5 Layouts, widgets and utilities for Awesome WM 4.x
   6 -------------------------------------------------
   7
   8 :Author: Luke Bonham <dada [at] archlinux [dot] info>
   9 :Version: git
  10 :License: GNU-GPL2_
  11 :Source: https://github.com/copycat-killer/lain
  12
  13 Description
  14 -----------
  15
  16 **Note:** the update to 4.x is still in progress: if you experience issues, please report them in order to speed up the process.
  17
  18 Successor of awesome-vain_, this module provides new layouts, a set of widgets and utility functions, with the aim of improving Awesome_ usability and configurability.
  19
  20 Read the wiki_ for all the info.
  21
  22 Contributions
  23 -------------
  24
  25 Any contribution is welcome! Feel free to make a pull request.
  26
  27 Just make sure that:
  28
  29 - 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.
  30
  31 - 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.
  32
  33 - 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!
  34
  35 - You eventually update ``wiki`` submodule with a thorough section.
  36
  37 Contributed widgets have to be put in ``lain/widgets/contrib``.
  38
  39 Screenshots
  40 -----------
  41
  42 .. image:: http://i.imgur.com/8D9A7lW.png
  43 .. image:: http://i.imgur.com/9Iv3OR3.png
  44 .. image:: http://i.imgur.com/STCPcaJ.png
  45
  46 .. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
  47 .. _awesome-vain: https://github.com/vain/awesome-vain
  48 .. _Awesome: https://github.com/awesomeWM/awesome
  49 .. _wiki: https://github.com/copycat-killer/lain/wiki