From 53578fee8bc403015d660597902b85ae7dfcb6ac Mon Sep 17 00:00:00 2001 From: Bruno Sutic Date: Tue, 18 Aug 2015 23:56:57 +0200 Subject: [PATCH] Added guide for migrating from tmuxinator --- CHANGELOG.md | 1 + README.md | 2 + docs/migrating_from_tmuxinator.md | 72 +++++++++++++++++++++++++++++++ 3 files changed, 75 insertions(+) create mode 100644 docs/migrating_from_tmuxinator.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 9936938..bccbb7d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ - archive and compress pane contents file - make archive & compress pane contents process more portable - `mutt` added to the list of automatically restored programs +- added guide for migrating from tmuxinator ### v2.4.0, 2015-02-23 - add "tmux-test" diff --git a/README.md b/README.md index aa44c17..698564d 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,8 @@ You should now be able to use the plugin. ### Docs +- [Guide for migrating from tmuxinator](docs/migrating_from_tmuxinator.md) + **Configuration** - [Changing the default key bindings](docs/custom_key_bindings.md). diff --git a/docs/migrating_from_tmuxinator.md b/docs/migrating_from_tmuxinator.md new file mode 100644 index 0000000..1f8463d --- /dev/null +++ b/docs/migrating_from_tmuxinator.md @@ -0,0 +1,72 @@ +# Migrating from `tmuxinator` + +### Why migrate to `tmux-resurrect`? + +Here are some reasons why you'd want to migrate from `tmuxinator` to +`tmux-resurrect`: + +- **Less dependencies**
+ `tmuxinator` depends on `ruby` which can be a hassle to set up if you're not a + rubyist.
+ `tmux-resurrect` depends just on `bash` which is virtually + omnipresent. + +- **Simplicity**
+ `tmuxinator` has an executable, CLI interface with half dozen commands and + command completion.
+ `tmux-resurrect` defines just 2 key bindings. + +- **No configuration**
+ `tmuxinator` is all about config files (and their constant updating).
+ `tmux-resurrect` requires no configuration to work. + +- **Better change handling**
+ When you make a change to any aspect of tmux layout, you also have to + update related `tmuxinator` project file (and test to make sure change is + ok).
+ With `tmux-resurrect` there's nothing to do: your change will be + remembered on the next save. + +### How to migrate? + +1. Install `tmux-resurrect`. +2. Open \*all* existing `tmuxinator` projects.
+ Verify all projects are open by pressing `prefix + s` and checking they are + all on the list. +3. Perform a `tmux-resurrect` save. + +That's it! You can continue using just `tmux-resurrect` should you choose so. + +Note: it probably makes no sense to use both tools at the same time as they do +the same thing (creating tmux environment for you to work in). +Technically however, there should be no issues. + +### Usage differences + +`tmuxinator` focuses on managing individual tmux sessions (projects). +`tmux-resurrect` keeps track of the \*whole* tmux environment: all sessions are +saved and restored together. + +A couple tips if you decide to switch to `tmux-resurrect`: + +- Keep all tmux sessions (projects) running all the time.
+ If you want to work on an existing project, you should be able to just + \*switch* to an already open session using `prefix + s`.
+ This is different from `tmuxinator` where you'd usually run `mux new [project]` + in order to start working on something. + +- No need to kill sessions with `tmux kill-session` (unless you really don't + want to work on it ever).
+ It's the recurring theme by now: just keep all the sessions running all the + time. This is convenient and also cheap in terms of resources. + +- The only 2 situations when you need `tmux-resurrect`:
+ 1) Save tmux environment just before restarting/shutting down your + computer.
+ 2) Restore tmux env after you turn the computer on. + +### Other questions? + +Still have questions? Feel free to open an +[issue](ihttps://github.com/tmux-plugins/tmux-resurrect/issues). We'll try to +answer it and also update this doc.