Go to file
Luke Bonham 1b12fd2319 removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02: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 scripts/dfs: specify bash instead of sh 2017-04-27 09:34:43 +02:00
util removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
widget removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
wiki@232d3b634d removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
.gitmodules wiki submodule updated 2015-08-05 13:31:15 +02:00
ISSUE_TEMPLATE.md issue template updated 2017-02-21 18:11:08 +01:00
LICENSE Create LICENSE 2016-10-24 10:58:47 +02:00
README.rst remove old screenshots 2017-07-21 14:06:33 +02:00
helpers.lua removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
init.lua removed whitespaced signatures; wiki updated 2017-09-04 12:43:00 +02:00
lain-git.rockspec widget.contrib.gpmdp: moved to awesome-www recipes; closes #354 #343 #342 2017-08-14 18:34:46 +02: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

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

Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_ WM. 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/copycat-killer/lain/wiki
.. _lain.helpers: https://github.com/copycat-killer/lain/blob/master/helpers.lua