mirror of
https://github.com/jimeh/tmuxifier.git
synced 2026-02-19 09:56:39 +00:00
Update readme
This commit is contained in:
44
README.md
44
README.md
@@ -43,7 +43,7 @@ You can then load that window layout into a new window in the
|
|||||||
current tmux session using:
|
current tmux session using:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tmuxifier window example
|
tmuxifier load-window example
|
||||||
```
|
```
|
||||||
|
|
||||||
Which will yield a Tmux window looking like this:
|
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"
|
[[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Configure & Customize
|
||||||
|
|
||||||
### Custom Installaton Path
|
### Custom Installaton Path
|
||||||
|
|
||||||
To install Tmuxifier to a custom path, clone the repository to your desired
|
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"
|
[[ -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:
|
it does set itself apart in a number of ways:
|
||||||
|
|
||||||
- Uses shell scripts to define Tmux sessions and windows instead of YAML
|
- 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
|
pre-defined window configurations, or just load a single window
|
||||||
configuration into your existing session.
|
configuration into your existing session.
|
||||||
- Tmuxifier is a set of shell scripts, meaning it doesn't require Ruby to be
|
- Tmuxifier is a set of shell scripts, meaning it doesn't require Ruby to be
|
||||||
installed on the machine to work.
|
installed on the machine.
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
[tmuxinator]: https://github.com/aziz/tmuxinator
|
[tmuxinator]: https://github.com/aziz/tmuxinator
|
||||||
[rbenv]: https://github.com/sstephenson/rbenv
|
[rbenv]: https://github.com/sstephenson/rbenv
|
||||||
@@ -100,8 +120,8 @@ it does set itself apart in a number of ways:
|
|||||||
## Heed My Warning
|
## Heed My Warning
|
||||||
|
|
||||||
Tmuxifier is pretty much an alpha product at this point. Documentation is
|
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
|
sketchy at best, and things might drastically change and/or break. If
|
||||||
that doesn't put you off, enjoy Tmuxifier :)
|
that doesn't put you off, please enjoy Tmuxifier :)
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user