Go to file
copycat-killer 7dce46c34d wiki updated 2017-01-06 13:46:24 +01:00
icons Added centerhwork, made auxiliary windows equally sized in centerwork and centerhwork 2015-09-17 17:14:05 -04:00
layout Added dynamic centerwork layout 2016-02-03 17:49:17 +01:00
scripts pull #239; better implementation 2016-12-04 12:42:39 +01:00
util wiki updated 2017-01-06 13:43:56 +01:00
widgets pulsebar: corrected colors typo; closes #251 2017-01-06 11:21:19 +01:00
wiki@ad794d1fea wiki updated 2017-01-06 13:46:24 +01:00
.gitmodules wiki submodule updated 2015-08-05 13:31:15 +02:00
LICENSE Create LICENSE 2016-10-24 10:58:47 +02:00
README.rst readme updated 2017-01-06 12:33:17 +01:00
asyncshell.lua asyncshell: minor fix to spawn with shell invocation 2016-08-05 12:53:04 +01:00
helpers.lua net/mpd widget resize fix; #248 2017-01-03 12:21:50 +01:00
init.lua net/mpd widget resize fix; #248 2017-01-03 12:21:50 +01:00
lain-git.rockspec bat: make update() available; #236 2016-11-19 10:30:58 +01:00

README.rst

Lain
====

-------------------------------------------------
Layouts, widgets and utilities for Awesome WM 4.x
-------------------------------------------------

:Author: Luke Bonham <dada [at] archlinux [dot] info>
:Version: git
:License: GNU-GPL2_
:Source: https://github.com/copycat-killer/lain

Description
-----------

**Note:** the update to 4.x is still in progress: if you experience issues, please report them in order to speed up the process.

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-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
.. _awesome-vain: https://github.com/vain/awesome-vain
.. _Awesome: https://github.com/awesomeWM/awesome
.. _wiki: https://github.com/copycat-killer/lain/wiki