Commit Diff

Commit:
bed04db79b135f8b7acce44581b2895067745ba2
From:
Aleksey Ryndin <continue@to.any-key.press>
Date:
Message:
README as markdown
Actions:
Patch | Tree
commit - 89f08ecb236f51e39d695a241e20ff73272bf688
commit + bed04db79b135f8b7acce44581b2895067745ba2
blob - d72c04acdf0a46c6ed2665532b8f91fb21f790e8 (mode 644)
blob + /dev/null
--- README
+++ /dev/null
@@ -1,12 +0,0 @@
-openbsd_i3_battery: User notification about low battery
-
-Environment:
-* OpenBSD: https://www.openbsd.org/
-* i3: https://i3wm.org/
-
-Install:
-$ git clone git clone ssh://anonymous@got.any-key.press/openbsd_i3_battery /home/<user>/openbsd_i3_battery
-
-Usage (append ~/.xsession):
-/home/<user>/openbsd_i3_battery/openbsd_i3_battery.sh -s \
-    /home/<user>/openbsd_i3_battery/openbsd_i3_battery.wav | logger -t openbsd_i3_battery &
blob - /dev/null
blob + c9630ccf66c6cbcc1284de701eaa85959e0996c1 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,21 @@
+# `openbsd_i3_battery`: User notification about low battery
+
+## Environment:
+
+* [OpenBSD](https://www.openbsd.org/)
+* [i3](https://i3wm.org/)
+
+## Install:
+
+```
+$ git clone ssh://anonymous@got.any-key.press/openbsd_i3_battery /home/<user>/openbsd_i3_battery
+```
+
+## Usage (append ~/.xsession):
+
+From `~/.xsession` (before `exec i3`): 
+
+```
+/home/<user>/openbsd_i3_battery/openbsd_i3_battery.sh -s \
+    /home/<user>/openbsd_i3_battery/openbsd_i3_battery.wav | logger -t openbsd_i3_battery &
+```