Go to file
Luca CPZ 013654cd1a
Merge pull request #420 from sim590/unpack-lua51-compat
util/menu_iterator: retro compatibility with lua 5.1
2019-02-14 15:26:41 +00:00
icons centerwork: mouse_resize_handler added; #395 2018-07-20 12:52:12 +02:00
layout API change: lain.widget.contrib.tpbat has been rewritten and renamed to lain.widget.contrib.tp_smapi 2018-11-28 20:01:22 +00:00
util util/menu_iterator: unpack retro compatibility 2019-02-13 14:19:07 -05:00
widget bat: allow disabling notification for full charge 2019-01-12 18:57:54 -05:00
wiki@7a99459660 widget.fs: fix notification check, add threshold parameter for trigger 2018-12-30 19:12:25 +01:00
.gitmodules pulseaudio -> pulse; scallback merged into cmd (read wiki) 2017-10-05 11:32:01 +02:00
ISSUE_TEMPLATE.md pulseaudio -> pulse; scallback merged into cmd (read wiki) 2017-10-05 11:32:01 +02:00
LICENSE Create LICENSE 2016-10-24 10:58:47 +02:00
README.rst helpers: async_with_shell added 2017-12-19 17:20:59 +01:00
helpers.lua util/menu_iterator: unpack retro compatibility 2019-02-13 14:19:07 -05:00
init.lua Weather widget rewritten; first authorship updated 2018-02-15 12:24:31 +01:00
lain-scm-1.rockspec updating lain rockspec to follow new luarocks standards 2018-03-30 10:39:34 -03:00

README.rst

Lain
====

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

:Author: Luca CPZ
:Version: git
:License: GNU-GPL2_
:Source: https://github.com/lcpz/lain

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

Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_. Read the wiki_ for all the info.

Contributions
-------------

Constructive criticism and suggestions are welcome.

If you want to create a pull request, 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 to or using lain.helpers_. If something is unclear, or 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 you code works and does not break other parts of the module.

- You eventually update ``wiki`` submodule with a thorough section.

Contributed widgets have to be put in ``widget/contrib``.

.. _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/lcpz/lain/wiki
.. _lain.helpers: https://github.com/lcpz/lain/blob/master/helpers.lua