Go to file
copycat-killer 354fa23548 #263: followtag default to true; changing quake definition 2017-01-12 13:07:11 +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 port to awesome 4.0 completed; #248 2017-01-09 20:21:56 +01:00
util #263: followtag default to true; changing quake definition 2017-01-12 13:07:11 +01:00
widgets wiki updated; closes #261 2017-01-11 17:53:21 +01:00
wiki@9a9d036e50 #263: followtag default to true; changing quake definition 2017-01-12 13:07:11 +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 typo 2017-01-10 13:15:02 +01:00
asyncshell.lua asyncshell: minor fix to spawn with shell invocation 2016-08-05 12:53:04 +01:00
helpers.lua port to awesome 4.0 completed; #248 2017-01-09 20:21:56 +01:00
init.lua wiki updated #254; other fixes 2017-01-08 13:25:09 +01:00
lain-git.rockspec fs: options moved to constructor; #closes 259 2017-01-09 13:04:02 +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_. Be aware that it's no longer supported, so update to 4.x ASAP.

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

Successor of awesome-vain_, this module provides new layouts, a set of 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