]> git.madduck.net Git - etc/awesome.git/blobdiff - README.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

scripts/dfs: specify bash instead of sh
[etc/awesome.git] / README.rst
index a0cd369c7f81c41af06a0c2afa346f9d600d87f9..4515be7bfbea3c29d8d83e7723ff8ae2f4346258 100644 (file)
@@ -13,12 +13,12 @@ Layouts, widgets and utilities for Awesome WM 4.x
 Warning
 -------
 
-The update to 4.x is still in progress: if you experience issues, please report them in order to speed up the process.
+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.
+Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_ WM.
 
 Read the wiki_ for all the info.
 
@@ -31,13 +31,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 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``.
+Contributed widgets have to be put in ``widget/contrib``.
 
 Screenshots
 -----------
@@ -47,6 +47,8 @@ Screenshots
 .. image:: http://i.imgur.com/STCPcaJ.png
 
 .. _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