From 57226cfb978dd93ed0863103d4021a01e0b2897b Mon Sep 17 00:00:00 2001
From: Bruno Sutic <bruno.sutic@gmail.com>
Date: Wed, 18 Feb 2015 16:52:14 +0100
Subject: [PATCH] Docs for tmux auto start feature

---
 README.md                                     |  3 ++-
 scripts/handle_tmux_automatic_start/README.md | 26 +++++++++++++++++++
 2 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 scripts/handle_tmux_automatic_start/README.md

diff --git a/README.md b/README.md
index ea8c95e..b5d7e92 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,8 @@ This action starts automatically when the plugin is installed.
 
 Tmux is automatically started after the computer/server is turned on.
 
-Put `set -g @resurrect-auto-tmux-start 'on'` in `tmux.conf` to enable this.
+See the [instructions](scripts/handle_tmux_automatic_start/README.md) how to
+enable this for your system.
 
 #### Automatic restore
 
diff --git a/scripts/handle_tmux_automatic_start/README.md b/scripts/handle_tmux_automatic_start/README.md
new file mode 100644
index 0000000..da7e830
--- /dev/null
+++ b/scripts/handle_tmux_automatic_start/README.md
@@ -0,0 +1,26 @@
+# Automatic Tmux start
+
+Tmux is automatically started after the computer/server is turned on.
+
+### OS X
+
+To enable this feature:
+- put `set -g @resurrect-auto-tmux-start 'on'` in `tmux.conf`
+- reload `tmux.conf`
+
+Next time the computer is started:
+- `Terminal.app` window will open and resize to maximum size
+- `tmux` command will be executed in the terminal window
+- if "auto restore" feature is enabled, tmux will start restoring previous env
+
+Config options:
+- `set -g @resurrect-auto-tmux-start-options 'fullscreen'` - terminal window
+  will go fullscreen
+- `set -g @resurrect-auto-tmux-start-options 'iterm'` - start `iTerm` instead
+  of `Terminal.app`
+- `set -g @resurrect-auto-tmux-start-options 'iterm,fullscreen'` - start `iTerm`
+  in fullscreen
+
+### Linux
+
+Help with this would be greatly appreciated. Please get in touch.