Go to file
Simon Désaulniers 1d2f4a102e menu_iterator: generic menu creator function
A simple example usage is given over on the amh project~[1]

[1]: dcf101c8ef/exec/mpv.lua (L32)
2018-02-16 16:14:13 -05:00
icons optimised PNGs 2017-08-18 11:53:08 +02:00
layout removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
scripts pulseaudio -> pulse; scallback merged into cmd (read wiki) 2017-10-05 11:32:01 +02:00
util menu_iterator: generic menu creator function 2018-02-16 16:14:13 -05:00
widget calendar: remove trailing newlines of output 2017-12-15 01:07:56 +01:00
wiki@f395683e49 helpers: async_with_shell added 2017-12-19 17:20:59 +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 helpers: powerset and trivial_partition_set 2018-02-16 15:26:41 -05:00
init.lua removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
lain-git.rockspec helpers: async_with_shell added 2017-12-19 17:20:59 +01: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