Mercurial > hg > Members > atton > pmux
diff README.md @ 2:67a6071afec7
Rename tmuxinator -> pmuxinator
$ zmv **/*tmuxinator* **/*pmuxinator*
$ gsed -e 's/tmuxinator/pmuxinator/g' -i **/*.*
$ gsed -e 's/Tmuxinator/Pmuxinator/g' -i **/*.*
author | Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> |
---|---|
date | Mon, 21 Jul 2014 08:32:00 +0900 |
parents | 39b72942a4d2 |
children |
line wrap: on
line diff
--- a/README.md Mon Jul 21 08:29:18 2014 +0900 +++ b/README.md Mon Jul 21 08:32:00 2014 +0900 @@ -1,6 +1,6 @@ -# Tmuxinator +# Pmuxinator -[![Gem Version](https://badge.fury.io/rb/tmuxinator.png)](http://badge.fury.io/rb/tmuxinator) [![Build Status](https://secure.travis-ci.org/tmuxinator/tmuxinator.png)](http://travis-ci.org/tmuxinator/tmuxinator?branch=master) [![Coverage Status](https://coveralls.io/repos/tmuxinator/tmuxinator/badge.png)](https://coveralls.io/r/tmuxinator/tmuxinator) [![Code Climate](https://codeclimate.com/github/tmuxinator/tmuxinator.png)](https://codeclimate.com/github/tmuxinator/tmuxinator) [![Dependency Status](https://gemnasium.com/tmuxinator/tmuxinator.png)](https://gemnasium.com/tmuxinator/tmuxinator) +[![Gem Version](https://badge.fury.io/rb/pmuxinator.png)](http://badge.fury.io/rb/pmuxinator) [![Build Status](https://secure.travis-ci.org/pmuxinator/pmuxinator.png)](http://travis-ci.org/pmuxinator/pmuxinator?branch=master) [![Coverage Status](https://coveralls.io/repos/pmuxinator/pmuxinator/badge.png)](https://coveralls.io/r/pmuxinator/pmuxinator) [![Code Climate](https://codeclimate.com/github/pmuxinator/pmuxinator.png)](https://codeclimate.com/github/pmuxinator/pmuxinator) [![Dependency Status](https://gemnasium.com/pmuxinator/pmuxinator.png)](https://gemnasium.com/pmuxinator/pmuxinator) Create and manage tmux sessions easily. @@ -9,12 +9,12 @@ ## Installation ``` -gem install tmuxinator +gem install pmuxinator ``` ## Editor and Shell -tmuxinator uses your shell's default editor for opening files. If you're not +pmuxinator uses your shell's default editor for opening files. If you're not sure what that is type: ``` bash @@ -51,19 +51,19 @@ Add the following to your `~/.bashrc`: - source ~/.bin/tmuxinator.bash + source ~/.bin/pmuxinator.bash ### zsh Add the following to your `~/.zshrc`: - source ~/.bin/tmuxinator.zsh + source ~/.bin/pmuxinator.zsh ### fish -Move `tmuxinator.fish` to your `completions` folder: +Move `pmuxinator.fish` to your `completions` folder: - cp ~/.bin/tmuxinator.fish ~/.config/completions/ + cp ~/.bin/pmuxinator.fish ~/.config/completions/ ## Usage @@ -75,15 +75,15 @@ Create or edit your projects with: ``` -tmuxinator new [project] +pmuxinator new [project] ``` -For editing you can also use `tmuxinator open [project]`. `new` is aliased to +For editing you can also use `pmuxinator open [project]`. `new` is aliased to `o`,`open` and `n`. Your default editor (`$EDITOR`) is used to open the file. If this is a new project you will see this default config: ```yaml -# ~/.tmuxinator/sample.yml +# ~/.pmuxinator/sample.yml name: sample root: ~/ @@ -126,7 +126,7 @@ ## Panes **_Note that if you wish to use panes, make sure that you do not have `.` in your project name. tmux uses `.` to delimit between window and pane indices, -and tmuxinator uses the project name in combination with these indices to target the correct pane or window._** +and pmuxinator uses the project name in combination with these indices to target the correct pane or window._** Panes are optional and are children of window entries, but unlike windows, they do not need a name. In the following example, the `editor` window has 2 panes, one running vim, the other guard. @@ -145,7 +145,7 @@ ## Interpreter Managers & Environment Variables -To use tmuxinator with rbenv, RVM, NVM etc, use the `pre_window` option. +To use pmuxinator with rbenv, RVM, NVM etc, use the `pre_window` option. ``` pre_window: rbenv shell 2.0.0-p247 @@ -155,7 +155,7 @@ ## Passing directly to send-keys -tmuxinator passes commands directly to send keys. This differs from simply chaining commands together using `&&` or `;`, in that +pmuxinator passes commands directly to send keys. This differs from simply chaining commands together using `&&` or `;`, in that tmux will directly send the commands to a shell as if you typed them in. This allows commands to be executed on a remote server over SSH for example. @@ -183,12 +183,12 @@ This will fire up tmux with all the tabs and panes you configured. ``` -tmuxinator start [project] +pmuxinator start [project] ``` ## Shorthand -A shorthand alias for tmuxinator can also be used. +A shorthand alias for pmuxinator can also be used. ``` mux [command] @@ -198,42 +198,42 @@ Copy an existing project. Aliased to `c` and `cp` ``` -tmuxinator copy [existing] [new] +pmuxinator copy [existing] [new] ``` List all the projects you have configured. Aliased to `l` and `ls` ``` -tmuxinator list +pmuxinator list ``` Remove a project. Aliased to `rm` ``` -tmuxinator delete [project] +pmuxinator delete [project] ``` -Remove all tmuxinator configs, aliases and scripts. Aliased to `i` +Remove all pmuxinator configs, aliases and scripts. Aliased to `i` ``` -tmuxinator implode +pmuxinator implode ``` Examines your environment and identifies problems with your configuration ``` -tmuxinator doctor +pmuxinator doctor ``` -Shows tmuxinator's help. Aliased to `h` +Shows pmuxinator's help. Aliased to `h` ``` -tmuxinator help +pmuxinator help ``` Shows the shell commands that get executed for a project ``` -tmuxinator debug [project] +pmuxinator debug [project] ``` -Shows tmuxinator's version. +Shows pmuxinator's version. ``` -tmuxinator version +pmuxinator version ``` ## FAQ @@ -244,7 +244,7 @@ ## Contributing -To contribute, please read the [contributing guide](https://github.com/tmuxinator/tmuxinator/blob/master/CONTRIBUTING.md). +To contribute, please read the [contributing guide](https://github.com/pmuxinator/pmuxinator/blob/master/CONTRIBUTING.md). ## Copyright