Improve documentation
This commit is contained in:
parent
8df40e6ee3
commit
f461b51a62
@ -1,6 +1,6 @@
|
|||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
Teamocil is a tool used to automatically create windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows.
|
Teamocil is a tool used to automatically create sessions, windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
@ -10,6 +10,11 @@ Teamocil is a tool used to automatically create windows and splits in `tmux` wit
|
|||||||
$ tmux
|
$ tmux
|
||||||
$ teamocil sample
|
$ teamocil sample
|
||||||
|
|
||||||
|
# Options
|
||||||
|
|
||||||
|
* `--here` opens the session from the current window, it doesn’t create an empty first window.
|
||||||
|
* `--layout` takes a custom file path to a YAML layout file.
|
||||||
|
|
||||||
# Layout example
|
# Layout example
|
||||||
|
|
||||||
# ~/.teamocil/sample.yml
|
# ~/.teamocil/sample.yml
|
||||||
@ -27,7 +32,7 @@ Teamocil is a tool used to automatically create windows and splits in `tmux` wit
|
|||||||
- cmd: memcached -p 11211 -vv
|
- cmd: memcached -p 11211 -vv
|
||||||
height: 25
|
height: 25
|
||||||
|
|
||||||
will create a new window named `sample-window` with a layout like this:
|
Running `$ teamocil sample` will rename the session to `sample-session` and create a new window named `sample-window` with a layout like this:
|
||||||
|
|
||||||
.------------------.------------------.
|
.------------------.------------------.
|
||||||
| (0) | (1) |
|
| (0) | (1) |
|
||||||
|
Loading…
Reference in New Issue
Block a user