Go to file
copycat-killer 75df71f9a1 rockspec: description like readme; closes #231 2016-10-23 10:26:21 +02: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 dfs: fix misalignments; widgets/weather: added APPID argument 2015-10-10 10:20:45 +02:00
util #221 use string.format; wiki updated 2016-08-11 13:43:35 +02:00
widgets weather: weather_now check if table and not just nil 2016-10-12 19:14:48 +02:00
wiki@4521f127d3 alsabar: failsafe for ALSA configs not starting from init 2016-09-29 10:48:27 +02:00
.gitmodules wiki submodule updated 2015-08-05 13:31:15 +02:00
README.rst wiki & readme updated 2016-07-10 11:05:26 +02:00
asyncshell.lua asyncshell: minor fix to spawn with shell invocation 2016-08-05 12:53:04 +01:00
helpers.lua net: specify ip path; #102 2016-09-13 16:29:17 +02:00
init.lua issue #9 fix attempt 2015-08-05 13:30:31 +02:00
lain-git.rockspec rockspec: description like readme; closes #231 2016-10-23 10:26:21 +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-GPL2_
: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-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