diff options
| author | JozanLeClerc <bousset.rudy@gmail.com> | 2019-11-19 09:14:00 +0100 |
|---|---|---|
| committer | JozanLeClerc <bousset.rudy@gmail.com> | 2019-11-19 09:14:00 +0100 |
| commit | c9a9a24e52292569bed93839db2240ae8dd16a2b (patch) | |
| tree | 414d2a77f5883886105302b9d657bceb603ea71c | |
| parent | Man update (diff) | |
| download | lowbat-gnu-c9a9a24e52292569bed93839db2240ae8dd16a2b.tar.gz lowbat-gnu-c9a9a24e52292569bed93839db2240ae8dd16a2b.tar.bz2 lowbat-gnu-c9a9a24e52292569bed93839db2240ae8dd16a2b.tar.xz lowbat-gnu-c9a9a24e52292569bed93839db2240ae8dd16a2b.tar.zst lowbat-gnu-c9a9a24e52292569bed93839db2240ae8dd16a2b.zip | |
Deleted README
| -rw-r--r-- | README.md | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 4dd8bac..0000000 --- a/README.md +++ /dev/null @@ -1,57 +0,0 @@ -# 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. - -## Dependencies - -+ `make` -+ `libnotify` -+ `espeak` - -## Installation - -Open a terminal and run these commands: - -```shell -git clone https://github.com/JozanLeClerc/lowbat.git -cd lowbat -sudo make install -``` - -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 -lowbat > /dev/null 2>&1 & -``` - -## Options - -Two options are available: - -+ `--say [MESSAGE]` allows you to set your own warning message lowbat is active. -+ `--silent` disables audio warnings. - -#### Examples of use: - -```shell -lowbat --say "your custom message" > /dev/null 2>&1 -``` - -```shell -lowbat --silent > /dev/null 2>&1 -``` - -## Uninstallation - -```shell -sudo make uninstall -``` - -## See also - -For more informations, see: - -```shell -man 1 lowbat -```
\ No newline at end of file |