aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7761fd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+dwmclock
+========
+
+Show the time and current battery charge in the X root window name
+
+Requirements
+------------
+
+- Xlib headers
+
+
+Installation
+------------
+
+Copy `config.def.mk` to `config.mk` and edit it to match your setup.
+
+Compile it:
+
+ make
+
+Install dwmclock (needs to be run as root if installing to `/usr` or `/usr/local`):
+
+ make instal
+
+Install dwmclock to ~/bin:
+
+ make DESTDIR=$HOME PREFIX= install
+
+
+Usage
+-----
+
+Amp it off in your ~/.xinitrc:
+
+ dwmclock &