Go to file
Luke Bonham a899e34790 Updated imap (markdown) 2015-08-05 13:30:32 +02:00
icons issue #2 fix attempt; centerfair added; small fixes 2015-08-05 13:30:31 +02:00
layout bat: fix issue #17 2015-08-05 13:30:31 +02:00
scripts issue #9 fix 2015-08-05 13:30:31 +02:00
util issue #11 typos fixed 2015-08-05 13:30:31 +02:00
widgets simple fix to #20 2015-08-05 13:30:31 +02:00
wiki@f996cdb74e wiki: improved imap widget section 2015-08-05 13:30:31 +02:00
.gitmodules full dynamic tagging and wiki added 2015-08-05 13:30:30 +02:00
Home.md Initial Commit 2015-08-05 13:30:31 +02:00
LICENSE Initial commit 2015-08-05 13:30:27 +02:00
Layouts.md Updated Layouts (markdown) 2015-08-05 13:30:31 +02:00
README.rst wiki updated 2015-08-05 13:30:31 +02:00
To-start.md Created To start (markdown) 2015-08-05 13:30:31 +02:00
Widgets.md Created Widgets (markdown) 2015-08-05 13:30:32 +02:00
alsa.md Updated alsa (markdown) 2015-08-05 13:30:32 +02:00
alsabar.md Updated alsabar (markdown) 2015-08-05 13:30:32 +02:00
bat.md Created bat (markdown) 2015-08-05 13:30:32 +02:00
borderbox.md Created borderbox (markdown) 2015-08-05 13:30:32 +02:00
calendar.md Updated calendar (markdown) 2015-08-05 13:30:32 +02:00
cpu.md Updated cpu (markdown) 2015-08-05 13:30:32 +02:00
fs.md Updated fs (markdown) 2015-08-05 13:30:32 +02:00
helpers.lua yawn: localizations and icons updated 2015-08-05 13:30:31 +02:00
imap.md Updated imap (markdown) 2015-08-05 13:30:32 +02:00
init.lua issue #9 fix attempt 2015-08-05 13:30:31 +02:00
maildir.md Updated maildir (markdown) 2015-08-05 13:30:32 +02:00
mem.md Updated mem (markdown) 2015-08-05 13:30:32 +02:00
mpd.md Updated mpd (markdown) 2015-08-05 13:30:32 +02:00
net.md Updated net (markdown) 2015-08-05 13:30:32 +02:00
sysload.md Updated sysload (markdown) 2015-08-05 13:30:32 +02:00
temp.md Updated temp (markdown) 2015-08-05 13:30:32 +02: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