]> 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
widget.temp: autodetect tempfiles; closes #431
[etc/awesome.git] / README.rst
diff --git a/README.rst b/README.rst
index de2ed650c085fbbc7c1b2a15b1e835972ffdbafd..f1a28413312ed5659a7527ba4bc102d22f604caa 100644 (file)
--- 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 not 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 update ``wiki`` submodule with a thorough section, if necessary.
 
-.. 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
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.