Merge pull request #245 from brucec5/master

[etc/awesome.git] / README.rst

diff --git a/README.rst b/README.rst
index 66d846c0ef494a2b7de48fe2ace22269c72d0ebe..87e11b599abf85028e0a2eebddae8a89f3d4d228 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,21 +1,19 @@
 Lain
 ====
 
----------------------------------------------
-Layouts, widgets and utilities for Awesome WM
----------------------------------------------
+--------------------------------------------------
+Layouts, widgets and utilities for Awesome WM 3.5+
+--------------------------------------------------
 
 :Author: Luke Bonham <dada [at] archlinux [dot] info>
-: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.
+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.
 
@@ -28,13 +26,13 @@ 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.
+- 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 work, 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 +41,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