summaryrefslogtreecommitdiff
path: root/run-shell
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2019-02-04 20:33:17 -0500
committerstreetturtle <streetturtle@gmail.com>2019-02-04 20:33:17 -0500
commit2f1644f7cbc1a090ceea89351611150e5451a4cf (patch)
tree303ae452f889c66dd0cc29287ace79d3de128332 /run-shell
parent0bbbfe8b67aacb6bdb672ff98d6bf4ba6ca4441a (diff)
update readme
Diffstat (limited to 'run-shell')
-rw-r--r--run-shell/README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/run-shell/README.md b/run-shell/README.md
index 098de6f..ad409e2 100644
--- a/run-shell/README.md
+++ b/run-shell/README.md
@@ -2,4 +2,24 @@
Blurs background and shows widget with run prompts:
-![screenshot](./screenshot.png) \ No newline at end of file
+![screenshot](./screenshot.png)
+
+## Install
+
+1. Clone this repo under **~/.config/awesome/**:
+
+ ```bash
+ git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+ ```
+
+1. Require weather widget at the beginning of **rc.lua**:
+
+ ```lua
+ local run_shell = require("awesome-wm-widgets.run_shell.run_shell")
+ ```
+
+1. Use it (don't forget to comment out the default prompt):
+
+ ```lua
+ awful.key({modkey}, "r", function () run_shell.launch() end),
+ ``` \ No newline at end of file