Add README.md file

Miguel Barão
1 parent ce4638ed
Showing 1 changed file with 18 additions and 0 deletions Show diff stats
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)"
+```
@@ -0,0 +1,18 @@		@@ -0,0 +1,18 @@
	1	+# Battery for tmux in FreeBSD
	2	+
	3	+This is is a little program to use in the tmux status bar to indicate the
	4	+current battery state a life.
	5	+It uses the FreeBSD `sysctl` and is not compatible with Linux.
	6	+
	7	+Compile with
	8	+
	9	+```sh
	10	+cc -Os battery.c -o battery
	11	+```
	12	+
	13	+In `~/.tmux.conf` setup the status bar like the following, with the correct path
	14	+to the executable.
	15	+
	16	+```tmux
	17	+set-option -g status-right "#(/path/to/battery)"
	18	+```