Go to file
luke bonham e95d34ccd8 readme updated 2015-08-05 13:30:30 +02:00
icons contrib section started\! 2015-08-05 13:30:30 +02:00
layout small code fixes 2015-08-05 13:30:30 +02:00
scripts mpd: default art added 2015-08-05 13:30:30 +02:00
util wiki updated 2015-08-05 13:30:30 +02:00
widgets contrib section started\! 2015-08-05 13:30:30 +02:00
wiki@91217d6bad contrib section started\! 2015-08-05 13:30:30 +02:00
.gitmodules full dynamic tagging and wiki added 2015-08-05 13:30:30 +02:00
LICENSE Initial commit 2015-08-05 13:30:27 +02:00
README.rst readme updated 2015-08-05 13:30:30 +02:00
helpers.lua small fixes 2015-08-05 13:30:30 +02:00
init.lua small fixes 2015-08-05 13:30:30 +02:00

README.rst

Lain
====

---------------------------------------------
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/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.

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

.. 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