aboutsummaryrefslogtreecommitdiff
path: root/.config/awesome/lain/README.rst
diff options
context:
space:
mode:
authorxero <x@xero.nu>2014-03-08 22:14:34 -0500
committerxero <x@xero.nu>2014-03-08 22:14:34 -0500
commitaedf4ef0ec9712789310b5b6d7d06af90f4f6261 (patch)
treeae25f438d4942195892dd9c311badcccf00dd4d8 /.config/awesome/lain/README.rst
parent02dd2db6564b9e3fd1e1582724bbd188f5de7db6 (diff)
downloaddotfiles_ascii-aedf4ef0ec9712789310b5b6d7d06af90f4f6261.tar.xz
dotfiles_ascii-aedf4ef0ec9712789310b5b6d7d06af90f4f6261.zip
add awesome wm config files and v0.1.0 of ghost theme.
Diffstat (limited to '.config/awesome/lain/README.rst')
-rw-r--r--.config/awesome/lain/README.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/.config/awesome/lain/README.rst b/.config/awesome/lain/README.rst
new file mode 100644
index 0000000..ca6569b
--- /dev/null
+++ b/.config/awesome/lain/README.rst
@@ -0,0 +1,49 @@
+Lain
+====
+
+---------------------------------------------
+Layouts, widgets and utilities for Awesome WM
+---------------------------------------------
+
+:Author: Luke Bonham <dada [at] archlinux [dot] info>
+:Version: git
+:License: GNU-GPLv2_
+:Source: https://github.com/copycat-killer/lain
+
+Description
+-----------
+
+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.
+
+**Note that** this module requires Awesome version 3.5 or higher.
+
+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 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``.
+
+Screenshots
+-----------
+
+.. image:: http://i.imgur.com/8D9A7lW.png
+.. 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
+.. _awesome-vain: https://github.com/vain/awesome-vain
+.. _Awesome: http://awesome.naquadah.org/
+.. _wiki: https://github.com/copycat-killer/lain/wiki