Go to file
luke bonham 59d9cd21ca base widget template added 2014-02-12 12:23:02 +01:00
icons issue #2 fix attempt; centerfair added; small fixes 2013-10-04 18:53:33 +02:00
layout bat: fix issue #17 2013-10-06 21:16:25 +02:00
scripts base widget template added 2014-02-12 12:23:02 +01:00
util issue #11 typos fixed 2013-11-12 10:41:04 +01:00
widgets wiki updated 2014-02-10 19:45:25 +01:00
wiki@60754084cf base widget template added 2014-02-12 12:23:02 +01:00
.gitmodules full dynamic tagging and wiki added 2013-09-19 20:51:28 +02:00
README.rst wiki updated 2014-01-04 12:35:16 +01:00
helpers.lua #25 blueluke's fix attempt 2014-02-09 10:36:40 +01:00
init.lua issue #9 fix attempt 2013-11-01 11:09:20 +01:00

README.rst

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.

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