Update readme, again

This commit is contained in:
2012-04-22 15:19:37 +01:00
parent 9cfc65489d
commit 8ddcd7a13d

View File

@@ -1,4 +1,4 @@
# tmuxifier # Tmuxifier
Tmuxify your Tmux. Create, edit and load complex Tmux session, window and pane Tmuxify your Tmux. Create, edit and load complex Tmux session, window and pane
configurations with ease. configurations with ease.
@@ -16,8 +16,10 @@ like. You will need to be very familiar with a few of Tmux's commands however.
## Example ## Example
Given with have a window layout file called `example.window.sh` which looks Given we have a window layout file called [example.window.sh][example] which
like: looks like:
[example]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh
```bash ```bash
window_name "Example Window" window_name "Example Window"
@@ -62,6 +64,12 @@ export TMUXIFIER="$HOME/.dotfiles/tmuxifier"
[[ -s "$TMUXIFIER/init.sh" ]] && source "$TMUXIFIER/init.sh" [[ -s "$TMUXIFIER/init.sh" ]] && source "$TMUXIFIER/init.sh"
``` ```
## 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 :)
## License ## License
Released under the MIT license. Copyright (c) 2012 Jim Myhrberg. Released under the MIT license. Copyright (c) 2012 Jim Myhrberg.