diff options
author | JozanLeClerc <bousset.rudy@gmail.com> | 2019-11-19 13:31:48 +0100 |
---|---|---|
committer | JozanLeClerc <bousset.rudy@gmail.com> | 2019-11-19 13:31:48 +0100 |
commit | b23f445d1b833016d3aa0ec19a0b95e2b05f82e9 (patch) | |
tree | 85493f9933038cb4936672d0c51e87dd9447f922 | |
parent | Now it's README.org (diff) | |
download | lowbat-gnu-b23f445d1b833016d3aa0ec19a0b95e2b05f82e9.tar.gz lowbat-gnu-b23f445d1b833016d3aa0ec19a0b95e2b05f82e9.tar.bz2 lowbat-gnu-b23f445d1b833016d3aa0ec19a0b95e2b05f82e9.tar.xz lowbat-gnu-b23f445d1b833016d3aa0ec19a0b95e2b05f82e9.tar.zst lowbat-gnu-b23f445d1b833016d3aa0ec19a0b95e2b05f82e9.zip |
README update
-rw-r--r-- | README.org | 61 |
1 files changed, 24 insertions, 37 deletions
@@ -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~. |