docs and cleanup

This commit is contained in:
John Bintz 2010-12-09 16:36:04 -05:00
parent 234a6734b3
commit da81776c0d
5 changed files with 86 additions and 19 deletions

2
.gitignore vendored
View File

@ -1,2 +1,2 @@
.bundle/*
*.gem

View File

@ -1,8 +0,0 @@
session :first do
screen "bundle exec autotest", :title => 'autotest'
screen!
end
session :second do
screen %{echo "cats"}
end

85
README.md Normal file
View File

@ -0,0 +1,85 @@
# screenie
You like screen, I like screen. Make getting those big multi-command line-running projects
even easier to get started up with `screenie`.
## How?
Make a `.screenie` file in your app and write:
<pre>
session do
screen "bundle exec autotest", :title => "autotest"
screen "rails c", :title => "dev console"
screen "rails s", :title => "dev server"
screen "less +F -fr log/test.log", :title => "test log tail"
screen! :title => "bash"
end
</pre>
Then run:
screenie
_~~whoa~~_
### More?
<pre>
session :backend do
screen "bundle exec autotest", :title => "autotest"
screen "less +F -fr log/test.log", :title => "test log tail"
screen! :title => "bash"
end
session :frontend do
screen "bundle exec autotest", :title => "autotest"
screen "rails c", :title => "console"
screen "rails s", :title => "server"
screen "rake jasmine", :title => "jasmine"
screen! :title => "bash"
end
</pre>
Then run:
screenie backend
or even:
screenie frontend
## Defaults?
Like magic `screenie` bits anywhere? `~/.screenie' is what you want! Same syntax!
## Ruby? DRY?
Just like `Gemfile`, `*.gemspec`, and other modern Ruby things, `.screenie` is Ruby code. Like
DRYing things? You can do it!
<pre>
class Screenie::DSL::Session
def whoa(&block)
screen :title => "first"
instance_eval(&block)
screen :title => "last"
end
end
session :first do
whoa do
screen "bundle exec autotest", :title => 'autotest'
end
end
session :second do
whoa do
screen %{echo "cats"}
end
end
</pre>
## What's left?
A _bunch_. I write what I need. Feel like addings fun things and/or tests? Fork, hack, pull request. You know the drill.

View File

@ -17,9 +17,6 @@ Gem::Specification.new do |s|
s.add_development_dependency "rspec"
s.add_development_dependency "mocha"
s.add_development_dependency "autotest"
s.add_development_dependency "cucumber"
s.add_development_dependency "aruba"
s.add_dependency 'thor'
s.files = `git ls-files`.split("\n")
s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

View File

@ -1,7 +0,0 @@
session :testing do
screen %{bundle exec autotest}, :name => 'autotest'
screen %{rails s}, :name => 'rails'
screen :name => 'command prompt'
select :first
end