X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/8c8ebdc1580f239cca3eb9f03b91cef8d321be34..1898354d7689dae919aa3e7e1f1d3b905b634c2f:/Home.md diff --git a/Home.md b/Home.md index bc479c0..5581a9e 100644 --- a/Home.md +++ b/Home.md @@ -1,26 +1,33 @@ Welcome to the Lain wiki! -### Dependencies +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. LuaSSL is out of date. -imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. +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. -*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)* +Installation +--------------- -### Installation +### Arch Linux -Simply clone this repository into your Awesome directory: +[AUR package](https://aur.archlinux.org/packages/lain/) + +### Other distributions git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain -then include it in your `rc.lua`: +Usage +-------- + +First, include it into your `rc.lua`: local lain = require("lain") -### Submodules +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)