README.md in termup-1.3.1 vs README.md in termup-2.0.0
- old
+ new
@@ -3,14 +3,16 @@
Automate opening up terminal tabs (or split panes) with a set of routine commands.
It's the easiest way to get started for your projects every day.
-Compatible with Terminal.app, iTerm and iTerm2 on Mac OS X 10.6 - 10.8 and Ruby 1.8.7 - 1.9.3.
+Compatible with Terminal.app and iTerm 2 on Mac OS X 10.6 - 10.8 and Ruby 1.8.7 - 1.9.3.
![Split Panes](https://github.com/kenn/termup/raw/master/images/split_panes.png)
+**iTerm 1 users** the current version is not compatible with iTerms 1. Use v1.3.1 - `gem install termup -v=1.3.1`
+
Installation
------------
```sh
$ gem install termup
@@ -24,42 +26,42 @@
### Getting Started ###
Call the following command:
```sh
-$ termup create new_project
+$ termup create myproject
```
-This will create a new project at `~/.config/termup/new_project.yml`. Edit the file:
+This will create a new project at `~/.config/termup/myproject.yml`. Edit the file:
```sh
-$ termup edit new_project
+$ termup edit myproject
```
And now you're good to go:
```sh
-$ termup start new_project
+$ termup start myproject
```
### YAML Syntax ###
```yaml
-# ~/.config/termup/new_project.yml
+# ~/.config/termup/myproject.yml
---
tabs:
- - tab1:
+ tab1:
- cd ~/projects/foo
- git status
- - mate .
- - tab2:
+ - subl .
+ tab2:
- mysql -u root
- show databases;
- - tab3:
+ tab3:
- cd ~/projects/foo
- tail -f log/development.log
- - tab4:
+ tab4:
- cd ~/projects/foo
- autotest
options:
iterm:
width: 2
@@ -71,13 +73,13 @@
### Shortcut ###
Commands have a shortcut for even fewer keystrokes.
```sh
-$ termup s new_project
+$ termup s myproject
```
-That's equivalent to `termup start new_project`.
+That's equivalent to `termup start myproject`.
### iTerm 2 Split Pane Support ###
Specify iTerm option to use split pane.