X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/ece950240fd5ad695b2b95801e582f7f12721718..617675d6c3a7b79d650bfcd52a3c13e8dcdfa459:/README.rst diff --git a/README.rst b/README.rst index 7f63942..e37d210 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,24 @@ 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 +Warning +------- + +If you still have to use branch 3.5.x, you can refer to the commit 301faf5_. Be aware that it's no longer supported, so update to 4.x ASAP. + 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. +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 +33,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 +46,8 @@ 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 +.. _301faf5: https://github.com/copycat-killer/lain/tree/301faf5370d045e94c9c344acb0fdac84a2f25a6 .. _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