.config/awesome/lain/wiki/Home.md

   1 Welcome to the Lain wiki!
   2
   3 If you spot a typo or have a suggestion to improve these pages, please notify me opening an [issue](https://github.com/lcpz/lain/issues) format. Thank you.
   4
   5 Dependencies
   6 ------------
   7
   8 Package | Requested by | Reasons of choice
   9 --- | --- | ---
  10 [curl](https://curl.haxx.se) | `imap`, `mpd`, and `weather` widgets | 1. faster and simpler to use than [LuaSocket](https://github.com/diegonehab/luasocket); 2. it's in the core of almost every distro; 3. can be called [asynchronously](https://awesomewm.org/doc/api/libraries/awful.spawn.html#easy_async)
  11 GLib >= 2.54 | `fs` widget | Pure Awesome/Lua implementation.
  12
  13 The second dependency will be removed once all major distros update their Gio/Glib versions.
  14
  15 Installation
  16 ------------
  17
  18 ### Arch Linux
  19
  20 [AUR package](https://aur.archlinux.org/packages/lain-git/)
  21
  22 ### Other distributions
  23
  24 ```shell
  25 git clone https://github.com/lcpz/lain.git ~/.config/awesome/lain
  26 ```
  27
  28 Also available via [LuaRocks](https://luarocks.org/modules/aajjbb/lain).
  29
  30 Usage
  31 --------
  32
  33 First, include it into your `rc.lua`:
  34
  35 ```lua
  36 local lain = require("lain")
  37 ```
  38
  39 Then check out the submodules you want:
  40
  41 - [Layouts](https://github.com/lcpz/lain/wiki/Layouts)
  42 - [Widgets](https://github.com/lcpz/lain/wiki/Widgets)
  43 - [Utilities](https://github.com/lcpz/lain/wiki/Utilities)