]> 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:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Change io.popen to io.open so we don't execute image files.
[etc/awesome.git] / README.rst
diff --git a/README.rst b/README.rst
index de2ed650c085fbbc7c1b2a15b1e835972ffdbafd..75ed867e7aec7ad70bef2b8af8198276796df01e 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,16 +5,37 @@ Lain
 Layouts, widgets and utilities for Awesome WM
 ---------------------------------------------
 
 Layouts, widgets and utilities for Awesome WM
 ---------------------------------------------
 
-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: 1.0-git
+:License: GNU-GPLv2_
+: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.
+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.
 
 Read the wiki_ for all the info.
 
 
 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 have not broken other parts of the module too!
+
+- You update ``wiki`` submodule with a thorough section.
+
+Contributed widgets have to be put it in ``lain/widget/contrib``.
+
 Screenshots
 -----------
 
 Screenshots
 -----------
 
@@ -24,4 +45,5 @@ Screenshots
 
 .. _GNU-GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
 .. _awesome-vain: https://github.com/vain/awesome-vain
 
 .. _GNU-GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
 .. _awesome-vain: https://github.com/vain/awesome-vain
+.. _Awesome: http://awesome.naquadah.org/
 .. _wiki: https://github.com/copycat-killer/lain/wiki
 .. _wiki: https://github.com/copycat-killer/lain/wiki
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.