Go to file
copycat-killer 312947f46e readme updated 2017-01-24 16:38:49 +01:00
icons centerworkh default icons added 2017-01-23 23:11:52 +01:00
layout layout: fixed spaces 2017-01-18 22:57:26 +01:00
scripts mem: math.floor->ceil and substract SReclaimable too from the total; closes #271 2017-01-23 13:35:30 +01:00
util quake: add settings function; closes #273 2017-01-23 15:46:33 +01:00
widgets mem: adjusted calculation; #271 2017-01-24 16:38:28 +01:00
wiki@df5dd684ec helpers.newtimer: added stoppable option 2017-01-24 16:15:40 +01:00
.gitmodules wiki submodule updated 2015-08-05 13:31:15 +02:00
ISSUE_TEMPLATE.md taskwarrior: asynchronous; #213 enhanced 2017-01-23 20:58:19 +01:00
LICENSE Create LICENSE 2016-10-24 10:58:47 +02:00
README.rst readme updated 2017-01-24 16:38:49 +01:00
helpers.lua helpers.newtimer: added stoppable option 2017-01-24 16:15:40 +01:00
init.lua wiki updated #254; other fixes 2017-01-08 13:25:09 +01:00
lain-git.rockspec rockspec typo 2017-01-12 20:43:23 +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

Warning
-------

If you still have to use branch 3.5.x, you can refer to the commit 301faf5_, but be aware that it's no longer supported.

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

Successor of awesome-vain_, this module provides new layouts, asynchronous widgets and utility functions, with the aim of improving 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
.. _301faf5: https://github.com/copycat-killer/lain/tree/301faf5370d045e94c9c344acb0fdac84a2f25a6
.. _awesome-vain: https://github.com/vain/awesome-vain
.. _Awesome: https://github.com/awesomeWM/awesome
.. _wiki: https://github.com/copycat-killer/lain/wiki
.. _lain.helpers: https://github.com/copycat-killer/lain/blob/master/helpers.lua