From: Luke Bonham <dadasignificanulla@gmail.com>
Date: Sat, 7 Sep 2013 10:10:58 +0000 (-0700)
Subject: Created To start (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/00cd5d9e596528c808ffec67df7cb726dff6ffe9?ds=sidebyside;hp=9ec8af2c6f2d4b5c94949aa0502ab994f120d0af

Created To start (markdown)
---

diff --git a/To-start.md b/To-start.md
new file mode 100644
index 0000000..9135be2
--- /dev/null
+++ b/To-start.md
@@ -0,0 +1,26 @@
+All you have to do is to include the module:
+
+	local lain = require("lain")
+
+Some widgets require a terminal, lain default is `xterm`, but can be changed:
+
+	lain.widgets.terminal = "urxvtc"
+
+or
+
+	lain.widgets.terminal = terminal
+
+providing you have something like this:
+
+    terminal = "urxvtc"
+
+in your `rc.lua`.
+
+`terminal` may also be a lua function that accepts one parameter.
+Something like this:
+
+	function footerm(cmd)
+           -- elaborate cmd
+	end
+
+	lain.widgets.terminal = footerm
\ No newline at end of file