From b23f445d1b833016d3aa0ec19a0b95e2b05f82e9 Mon Sep 17 00:00:00 2001
From: JozanLeClerc <bousset.rudy@gmail.com>
Date: Tue, 19 Nov 2019 13:31:48 +0100
Subject: README update

---
 README.org | 61 ++++++++++++++++++++++++-------------------------------------
 1 file changed, 24 insertions(+), 37 deletions(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index a1c517c..14b2cac 100644
--- a/README.org
+++ b/README.org
@@ -1,57 +1,44 @@
-# lowbat
+* lowbat
+Very small script that runs in the background and warns you when your battery is low until you plug your laptop in. It also is POSIX-compliant, which is nice.
 
-Very small script that runs in the background and warns you when your battery is low until you plug your laptop in.  
-It also is POSIX-compliant, which is nice.
-
-## Dependencies
-
-+ `make`
-+ `libnotify`
-+ `espeak`
-
-## Installation
+** Dependencies
+- ~make~
+- ~libnotify~
+- ~espeak~
 
+** Installation
 Open a terminal and run these commands:
 
-```shell
+#+BEGIN_SRC shell
 git clone https://github.com/JozanLeClerc/lowbat.git
 cd lowbat
 sudo make install
-```
+#+END_SRC
 
 Next you must find a way to get the script running right after loging in. Add this to your startup programs manager/rc file of choice:
 
-```shell
+#+BEGIN_SRC shell
 lowbat > /dev/null 2>&1 &
-```
-
-## Options
+#+END_SRC
 
+** Options
 Two options are available:
+- ~--say [MESSAGE]~ allows you to set your own warning message lowbat is active.
+- ~--silent~ disables audio warnings.
 
-+ `--say [MESSAGE]` allows you to set your own warning message lowbat is active.
-+ `--silent` disables audio warnings.
-
-#### Examples of use:
-
-```shell
+**** Examples of use:
+#+BEGIN_SRC shell
 lowbat --say "your custom message" > /dev/null 2>&1
-```
+#+END_SRC
 
-```shell
+#+BEGIN_SRC shell
 lowbat --silent > /dev/null 2>&1
-```
-
-## Uninstallation
+#+END_SRC
 
-```shell
+** Uninstallation
+#+BEGIN_SRC shell
 sudo make uninstall
-```
-
-## See also
-
-For more informations, see:
+#+END_SRC
 
-```shell
-man 1 lowbat
-```
+** See also
+For more informations, check ~man lowbat~.
-- 
cgit v1.2.3