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

diff --git a/README.rst b/README.rst
index de2ed65..098f6bc 100644
--- a/README.rst
+++ b/README.rst
@@ -1,27 +1,39 @@
 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: Luca CPZ
+:Version: git
+:License: GNU-GPL2_
+:Source: https://github.com/lcpz/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.
+Description
+-----------
 
-Read the wiki_ for all the info.
+Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_. Read the wiki_ for all the info.
 
-Screenshots
------------
+Contributions
+-------------
+
+Constructive criticism and suggestions are welcome.
+
+If you want to create a pull request, 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 to or using lain.helpers_. If something is unclear, or 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 you code works and does not break other parts of the module.
+
+- You eventually update ``wiki`` submodule with a thorough section.
 
-.. image:: http://i.imgur.com/8D9A7lW.png
-.. image:: http://i.imgur.com/9Iv3OR3.png
-.. image:: http://i.imgur.com/STCPcaJ.png
+Contributed widgets have to be put in ``widget/contrib``.
 
-.. _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
-.. _wiki: https://github.com/copycat-killer/lain/wiki
+.. _Awesome: https://github.com/awesomeWM/awesome
+.. _wiki: https://github.com/lcpz/lain/wiki
+.. _lain.helpers: https://github.com/lcpz/lain/blob/master/helpers.lua