github-migration/teamocil
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README

Browse Source
This commit is contained in:
Rémi Prévost 2011-10-15 10:28:35 -04:00
parent 6c6d67e12d
commit 331ab490ce
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,6 +1,6 @@
# Teamocil
Teamocil is a simple 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.
Teamocil is a simple tool used to automatically create sessions, windows and splits in [tmux](http://tmux.sourceforge.net/) with YAML files.
## Usage
@ -168,6 +168,12 @@ To get autocompletion when typing `teamocil <Tab>` in a zsh session, add this li
compctl -g '~/.teamocil/*(:t:r)' teamocil
## Todo list
* Support tmux options for windows and splits (eg. `synchronize-panes`)
* Making sure the layout is valid before executing it
* Refactor the `Layout` class to make it “test-friendly”
## Contributors
Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/teamocil/issues), just like these fine folks did:
@ -177,4 +183,4 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
## License
Teamocil is © 2011 Rémi Prévost and may be freely distributed under the [LITL license](http://litl.info/). See the `LICENSE` file.
Teamocil is © 2011 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [LITL license](http://litl.info/). See the `LICENSE` file.