Go to file
aajjbb 72556c9cd1 fixing small typo in fs widget which lead to nil reference 2015-08-05 13:31:15 +02:00
icons better weather module: OpenWeatherMap; #105 2015-08-05 13:31:15 +02:00
layout whitespaces cleaning 2015-08-05 13:31:15 +02:00
scripts fixed mount point length calculation and misalignment of 4-digit size numbers 2015-08-05 13:31:15 +02:00
util whitespaces cleaning 2015-08-05 13:31:15 +02:00
widgets fixing small typo in fs widget which lead to nil reference 2015-08-05 13:31:15 +02:00
wiki@54b3a717b2 enhancement: unique timers for widgets; #114 2015-08-05 13:31:15 +02:00
.gitmodules wiki submodule updated 2015-08-05 13:31:15 +02:00
LICENSE Initial commit 2015-08-05 13:30:27 +02:00
README.rst readme updated 2015-08-05 13:30:38 +02:00
asyncshell.lua better weather module: OpenWeatherMap; #105 2015-08-05 13:31:15 +02:00
helpers.lua whitespaces cleaning 2015-08-05 13:31:15 +02:00
init.lua issue #9 fix attempt 2015-08-05 13:30:31 +02:00

README.rst

Lain
====

--------------------------------------------------
Layouts, widgets and utilities for Awesome WM 3.5+
--------------------------------------------------

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