summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpmakhov <pavel.makhov@savoirfairelinux.com>2017-10-12 20:36:40 -0400
committerpmakhov <pavel.makhov@savoirfairelinux.com>2017-10-12 20:36:40 -0400
commit91238d697ab1060587c973052d0fa36bce97e81b (patch)
tree59418f1015ca0aa38caeaed3ba6d16928553d72c
parent047c670cc67e33eb57bb88dfa93e71ffe82e5c53 (diff)
update readme
-rw-r--r--README.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/README.md b/README.md
index 7a909fe..e6905cb 100644
--- a/README.md
+++ b/README.md
@@ -39,20 +39,15 @@ sprtr,
# Installation
-[Install](https://github.com/horst3180/arc-icon-theme#installation) Arc icon theme and follow installation instructions of each widget.
+Clone repo under **~/.config/awesome/**, then in **rc.lua** add the import of the widget you'd like to use in "require" section on the top of the file:
-Or you can clone this repo under **~/.config/awesome/** and then add widgets you'd like to use in wibox:
-
-```bash
-cd ~/.config/awesome/
-git clone https://github.com/streetturtle/awesome-wm-widgets.git
+```lua
+require("awesome-wm-widgets.battery-widget.battery")
```
-and in **rc.lua**
+and then add widget to the wibox (you can search for **mytextclock** and add widget before):
```lua
-require("awesome-wm-widgets.battery-widget.battery")
-...
-- Add widgets to the wibox
s.mywibox:setup {
layout = wibox.layout.align.horizontal,
@@ -63,10 +58,13 @@ require("awesome-wm-widgets.battery-widget.battery")
{ -- Right widgets
...
battery_widget,
+ mytextclock
...
}
```
+You will also need to install [Arc icon theme](https://github.com/horst3180/arc-icon-theme). By default it should be installed under **/usr/share/icons/Arc**. If you prefer different installation folder then you'll have to change path to the icons in the source code of the widget you want to use.
+
# Icons
If you don't want to install Arc icon theme you can just download the icons which are used from the [Arc repository](https://github.com/horst3180/arc-theme).