diff --git a/README.md b/README.md new file mode 100644 index 0000000..a13f924 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# fmux +tmux configuration for lazy people who like F-keys + +This project implements byobu-like function key bindings for common tmux commands, but without as much overhead as byobu. It also adds some useful status-bar widgets on the right, implemented with a bash script. + +## Installation + +1. Clone this repository to your home folder. +2. Establish a symbolic link from the tmux.conf file in the repository folder your home folder: + ln -s /home/$USER/fmux/.tmux.conf /home/$USER/.tmux.conf +3. Start a new tmux session, or reload the configuration file in existing session(s).