Skip to content

Commit

Permalink
Update README to include open command and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
nesquena committed Sep 14, 2010
1 parent 706e8e6 commit 73b113d
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Expand Up @@ -6,14 +6,17 @@ Terminitor automates your development workflow by allowing you to script the com
Installation
------------


$ gem install terminitor
$ terminit setup

Usage
-------

Using terminitor is quite easy. First define your project files:
Using terminitor is quite easy. To define or edit a project file, simply invoke the command:

$ terminit open foo

This will open your default editor (set by the $EDITOR variable in BASH) and you can proceed to define the commands for that project:

# ~/.terminit/foo.yml
# you can make as many tabs as you wish...
Expand All @@ -33,11 +36,11 @@ Using terminitor is quite easy. First define your project files:
- autotest

Simply define the tabs and declare each command. Note that the session of each tab is maintained, so you just declare actions here as
you would manually in terminal.
you would manually type in the terminal.

Once the project file has been declared, simply execute any project defined in the @.terminit@ directory with:
Once the project file has been declared to your satisfaction, simply execute any project defined in the @.terminit@ directory with:

$ terminit foo
$ terminit start foo

This will execute the steps and create the tabs defined and run the various options as expected. That's it. Create as many project files with as many tabs
as you would like and automate your workflow.
Expand All @@ -48,11 +51,14 @@ Limitations
This only works on OS X because of the dependency on applescript. It would presumably not be impossible to port this to Linux or Windows, and
of course patches and suggestions are welcome.


Acknowledgements
-----------------

This code came originally years ago from: http://blog.elctech.com/2008/01/16/script-terminal-with-terminit/ .
This was a great start and made terminal automation easy. However, the repository is dead, but we had continued using the code for a while.
Finally, we decided the time had come to release this code back to the world as a gem. Thanks to ELC for creating the original
source for this project.
source for this project.

Also, we didn't take any code from [Project](http://github.com/joshnesbitt/project) by Josh but that project did inspire us to setup terminit
as a gem. Basically, project is a great gem but there were a couple issues with the fact that the terminal doesn't save the session state in some cases.
I had already been using terminit for years so we decided to package this up for easy use.

0 comments on commit 73b113d

Please sign in to comment.