From 2b70cb08c445b0ea3131518a228bf4ceffa35478 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Sun, 22 Apr 2012 18:08:56 +0100 Subject: [PATCH] Update readme --- README.md | 44 ++++++++++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 60dc042..0acb7d6 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ You can then load that window layout into a new window in the current tmux session using: ```bash -tmuxifier window example +tmuxifier load-window example ``` Which will yield a Tmux window looking like this: @@ -62,6 +62,8 @@ And add the following to your `~/.profile` or equivalent: [[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh" ``` +## Configure & Customize + ### Custom Installaton Path To install Tmuxifier to a custom path, clone the repository to your desired @@ -73,9 +75,33 @@ export TMUXIFIER="$HOME/.dotfiles/tmuxifier" [[ -s "$TMUXIFIER/init.sh" ]] && source "$TMUXIFIER/init.sh" ``` -## Differences From Tmuxinator? +### Custom Layouts Path -Though Tmuxifier is largely inspired by the excellent [tmuxinator][] project, +You can customize the layouts directory used by Tmuxifier by setting +`$TMUXIFIER_LAYOUT_PATH`. + +```bash +export TMUXIFIER_LAYOUT_PATH="$HOME/.tmux-layouts" +``` + +### Disable Shell-Completion + +Tmuxifier comes with shell-completion for bash and zsh shells. If for any +reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`. + +```bash +export TMUXIFIER_NO_COMPLETE=1 +``` + +## Inspiration + +- Tmuxifier is largely inspired by [Tmuxinator][]. +- The shell script structure and shell-completion setup is heavily + inspired/ripped from the internals of [rbenv][]. + +## Tmuxifier vs. Tmuxinator + +Though Tmuxifier is largely inspired by the excellent [Tmuxinator][] project, it does set itself apart in a number of ways: - Uses shell scripts to define Tmux sessions and windows instead of YAML @@ -86,13 +112,7 @@ it does set itself apart in a number of ways: pre-defined window configurations, or just load a single window configuration into your existing session. - Tmuxifier is a set of shell scripts, meaning it doesn't require Ruby to be - installed on the machine to work. - -## Inspiration - -- As mentioned above, Tmuxifier is largely inspired by [tmuxinator][]. -- I drew a lot of inspiration from [rbenv][] when it came to structuring the - project, shell commands, and completion. + installed on the machine. [tmuxinator]: https://github.com/aziz/tmuxinator [rbenv]: https://github.com/sstephenson/rbenv @@ -100,8 +120,8 @@ it does set itself apart in a number of ways: ## Heed My Warning Tmuxifier is pretty much an alpha product at this point. Documentation is -sketchy at best, and things might drastically change further down the line. If -that doesn't put you off, enjoy Tmuxifier :) +sketchy at best, and things might drastically change and/or break. If +that doesn't put you off, please enjoy Tmuxifier :) ## Todo