]> git.madduck.net Git - etc/awesome.git/blobdiff - Home.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated tpbat (markdown)
[etc/awesome.git] / Home.md
diff --git a/Home.md b/Home.md
index f8b1142fbb8ccd2928be7f91edc7abae0ac6c131..9ba836213b1ac352b0b1c194136181f5cf85d8b3 100644 (file)
--- a/Home.md
+++ b/Home.md
@@ -1,10 +1,34 @@
-### Installation
+Welcome to the Lain wiki!
 
-Simply clone this repository into your Awesome directory.
+Dependencies
+------------------
 
-### Index
+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 | 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:
 
-- [To start](https://github.com/copycat-killer/lain/wiki/To-start)
 - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts)
 - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
-- Utilities
\ No newline at end of file
+- [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities)
\ No newline at end of file