X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/4b2bb0b413766b23a9716984566aaaf0597ce961..f59c9644ab3daa1f186c5d4041184327184b9150:/README.rst diff --git a/README.rst b/README.rst index 75ed867..6c7bb01 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,21 @@ Lain ==== ---------------------------------------------- -Layouts, widgets and utilities for Awesome WM ---------------------------------------------- +------------------------------------------------- +Layouts, widgets and utilities for Awesome WM 4.x +------------------------------------------------- :Author: Luke Bonham -:Version: 1.0-git -:License: GNU-GPLv2_ +:Version: git +:License: GNU-GPL2_ :Source: https://github.com/copycat-killer/lain Description ----------- -Successor of awesome-vain_, this costantly evolving module -provides new layouts, a set of widgets and utility functions, -in order to improve Awesome_ usability and configurability. +**Note:** the update to 4.x is still in progress: if you experience issues, please report them in order to speed up the process. + +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. Read the wiki_ for all the info. @@ -30,11 +30,11 @@ Just make sure that: - 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. -- You test your changes before submitting to make sure that not only your code works, but have not broken other parts of the module too! +- 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! -- You update ``wiki`` submodule with a thorough section. +- You eventually update ``wiki`` submodule with a thorough section. -Contributed widgets have to be put it in ``lain/widget/contrib``. +Contributed widgets have to be put in ``lain/widgets/contrib``. Screenshots ----------- @@ -43,7 +43,7 @@ Screenshots .. image:: http://i.imgur.com/9Iv3OR3.png .. image:: http://i.imgur.com/STCPcaJ.png -.. _GNU-GPLv2: http://www.gnu.org/licenses/gpl-2.0.html +.. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html .. _awesome-vain: https://github.com/vain/awesome-vain -.. _Awesome: http://awesome.naquadah.org/ +.. _Awesome: https://github.com/awesomeWM/awesome .. _wiki: https://github.com/copycat-killer/lain/wiki