X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/dc60201567ec9bf39164d90a220cd61338ade23c..370a209580ee7ad57e957355e6b2e8dfadb400ab:/README.rst diff --git a/README.rst b/README.rst index 7f63942..23cfb9d 100644 --- a/README.rst +++ b/README.rst @@ -6,19 +6,19 @@ Layouts, widgets and utilities for Awesome WM --------------------------------------------- :Author: Luke Bonham -:Version: 1.0-git +:Version: git :License: GNU-GPLv2_ :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. +Successor of awesome-vain_, this module provides new layouts, a set of widgets and utility functions, in order to improve Awesome_ usability and configurability. Read the wiki_ for all the info. +**Note that**: this module requires Awesome version 3.5 or higher. + Contributions ------------- @@ -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/widget/contrib``. Screenshots -----------