From 9a5368c2456dfa1ca71763138facc6c615760b25 Mon Sep 17 00:00:00 2001
From: Miguel Barão <mjsb@uevora.pt>
Date: Fri, 24 Jun 2022 17:01:40 +0100
Subject: [PATCH] Add README.md file

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+), 0 deletions(-)
 create mode 100644 README.md

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