X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/c4ff9d6c8fb3b2aeed01b2668a2be469921a9ac0..0180aa3bc348520c01479c40cdf6343e36ce3e59:/README.rst?ds=sidebyside

diff --git a/README.rst b/README.rst
index de2ed65..2bb89a8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,20 +1,44 @@
 Lain
 ====
 
----------------------------------------------
-Layouts, widgets and utilities for Awesome WM
----------------------------------------------
+-------------------------------------------------
+Layouts, widgets and utilities for Awesome WM 4.x
+-------------------------------------------------
 
-Author: Luke Bonham <dada [at] archlinux [dot] info>
-Version: 1.0-git
-License: GNU-GPLv2_
-Source: https://github.com/copycat-killer/vain
+:Author: Luke Bonham <dada [at] archlinux [dot] info>
+:Version: git
+:License: GNU-GPL2_
+:Source: https://github.com/copycat-killer/lain
 
-Based on a port 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.
+Warning
+-------
+
+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.
+
+Description
+-----------
+
+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.
 
+Contributions
+-------------
+
+Any contribution is welcome! Feel free to make a pull request.
+
+Just make sure that:
+
+- 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.
+
+- 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 did not break other parts of the module too!
+
+- You eventually update ``wiki`` submodule with a thorough section.
+
+Contributed widgets have to be put in ``lain/widgets/contrib``.
+
 Screenshots
 -----------
 
@@ -22,6 +46,9 @@ 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: https://github.com/awesomeWM/awesome
 .. _wiki: https://github.com/copycat-killer/lain/wiki
+.. _lain.helpers: https://github.com/copycat-killer/lain/blob/master/helpers.lua