]> 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 borderbox (markdown)
[etc/awesome.git] / Home.md
diff --git a/Home.md b/Home.md
index 434dfdcc7d5095cf5b45a7f37003afb864965882..bc479c0370e1eb5cfb094a56f60f6d069e6aaa81 100644 (file)
--- a/Home.md
+++ b/Home.md
@@ -1,5 +1,27 @@
-### Index
+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. LuaSSL is out of date. 
+imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering.
+
+*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)*
+
+### Installation
+
+Simply clone this repository into your Awesome directory:
+
+    git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain
+
+then include it in your `rc.lua`:
+
+    local lain = require("lain")
+
+### Submodules
 
 - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts)
 - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
 - [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