From 304e5b057118994b62973d7a96df562e82e66fe4 Mon Sep 17 00:00:00 2001 From: Alessandro Mauri Date: Sun, 24 May 2020 00:35:26 +0200 Subject: [PATCH] simple readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e9c2821 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# bmon - simple battery monitor +Bmon is a simple tool that reads battery/power draw data and outputs it, +together with a timestamp, to stdout or into a file as tab separated values. + +## Requirements & building +The requirements are: +- gcc +- make +to compile the tool simply run `make` the executable will be in the current +directory ready to use. + +## Using it +bmon outputs tab separated data, the first element will be either the battery +capacity or the current power draw in milliwatts, this behaviour is controlled +by the `-w` argument. The second element is the time in seconds, this can be +time relative to the start of the program or the system time in unix time stamp, +this behaviour is controlled by the `-u` argument.\ +The sample rate (time between readings) can be controlled with the `-t ` +argument, this time is in seconds.\ +The output can be directed to stdout or to a specific file, this is controlled +with the `-f ` argument.\ +For further help refer to the man page. +