From 7854fd54a049da91d176b06ece8ea98a71a4220f Mon Sep 17 00:00:00 2001
From: Shaun Setlock <shaunsetlock@protonmail.com>
Date: Mon, 30 Dec 2024 20:28:07 -0500
Subject: [PATCH] Adding docs to help with setting up tmux.

---
 tmux/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 tmux/README.md

diff --git a/tmux/README.md b/tmux/README.md
new file mode 100644
index 0000000..d97be73
--- /dev/null
+++ b/tmux/README.md
@@ -0,0 +1,23 @@
+# Shaun's `tmux` Dotfiles
+
+## Location
+The configuration files need to be present at this location, `~/.config/tmux`. So, we can use the following command to softlink/symlink,
+
+```bash
+ln -s <location of cloned dotfiles tmux directory> ~/.config/tmux
+# e.g.
+# ln -s ~/dotfiles/tmux ~/.config/tmux
+```
+
+## Install Plugin Manager (`tpm`)
+We will use `tpm` as our plugin manager, but it cannot install itself. So we have to clone it into the proper place.
+`git clone https://github.com/tmux-plugins/tpm ~/.config/tmux/plugins/tpm`
+
+## Install Plugins
+Once the tmux symlink is created, we can install all plugins. This is done using tpm from within a tmux session.
+```bash
+tmux
+<leader> I
+# e.g.
+# Ctrl+b Shift+i 
+```