lain/Home.md

35 lines
1.0 KiB
Markdown

Welcome to the Lain wiki!
Dependencies
------------------
Package | Requested by | Reason of choice
--- | --- | ---
alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | /
curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+.
LuaSSL is out of date.
imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering.
Installation
---------------
### Arch Linux
[AUR package](https://aur.archlinux.org/packages/lain/)
### Other distributions
git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain
Usage
--------
First, include it into your `rc.lua`:
local lain = require("lain")
Then check out the submodules you want:
- [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts)
- [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
- [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities)