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 Warning
  14 -------
  15
  16 If you still have to use branch 3.5.x, you can refer to the commit 301faf5_, but be aware that it's no longer supported.
  17
  18 Description
  19 -----------
  20
  21 Successor of awesome-vain_, this module provides new layouts, asynchronous widgets and utility functions, with the aim of improving Awesome_ usability and configurability.
  22
  23 Read the wiki_ for all the info.
  24
  25 Contributions
  26 -------------
  27
  28 Any contribution is welcome! Feel free to make a pull request.
  29
  30 Just make sure that:
  31
  32 - 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.
  33
  34 - 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.
  35
  36 - 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!
  37
  38 - You eventually update ``wiki`` submodule with a thorough section.
  39
  40 Contributed widgets have to be put in ``lain/widgets/contrib``.
  41
  42 Screenshots
  43 -----------
  44
  45 .. image:: http://i.imgur.com/8D9A7lW.png
  46 .. image:: http://i.imgur.com/9Iv3OR3.png
  47 .. image:: http://i.imgur.com/STCPcaJ.png
  48
  49 .. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
  50 .. _301faf5: https://github.com/copycat-killer/lain/tree/301faf5370d045e94c9c344acb0fdac84a2f25a6
  51 .. _awesome-vain: https://github.com/vain/awesome-vain
  52 .. _Awesome: https://github.com/awesomeWM/awesome
  53 .. _wiki: https://github.com/copycat-killer/lain/wiki
  54 .. _lain.helpers: https://github.com/copycat-killer/lain/blob/master/helpers.lua