Go to file
Luca CPZ 6b3bdcaed1
#474: remove remaining 9 warnings
2020-11-30 14:58:27 +00:00
icons centerwork: mouse_resize_handler added; #395 2018-07-20 12:52:12 +02:00
layout #474: remove remaining 9 warnings 2020-11-30 14:58:27 +00:00
util #474: remove remaining 9 warnings 2020-11-30 14:58:27 +00:00
widget Merge branch 'master' of https://github.com/staticssleever668/lain into staticssleever668-master 2020-11-30 14:29:27 +00:00
wiki@2899629c44 Wiki update 2020-11-01 19:27:00 -08: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 readme updated 2019-08-27 17:10:06 +01:00
helpers.lua #474: remove remaining 9 warnings 2020-11-30 14:58:27 +00: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_.

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 not 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 update ``wiki`` submodule with a thorough section, if necessary.

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