diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0fe63d --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Battery for tmux in FreeBSD + +This is is a little program to use in the tmux status bar to indicate the +current battery state a life. +It uses the FreeBSD `sysctl` and is not compatible with Linux. + +Compile with + +```sh +cc -Os battery.c -o battery +``` + +In `~/.tmux.conf` setup the status bar like the following, with the correct path +to the executable. + +```tmux +set-option -g status-right "#(/path/to/battery)" +``` -- libgit2 0.21.2