Permalink
Browse files

improve documentation including licenses

  • Loading branch information...
1 parent a574061 commit bdb070211e764dfbb91c81f39c183dc758a9037d @alexch committed Jun 16, 2009
Showing with 21 additions and 14 deletions.
  1. +8 −3 LICENSE
  2. +13 −11 README.md
View
11 LICENSE
@@ -1,4 +1,4 @@
-rerun
+Rerun
Copyright (c) 2009 Alex Chaffee <alex@stinky.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -21,9 +21,14 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
---
rerun partially based on code from Rspactor
-[insert license]
+Copyright (c) 2009 Mislav Marohnić
+License as above (MIT open source).
rerun partially based on code from FileSystemWatcher
http://paulhorman.com/filesystemwatcher/
-[insert license]
+No license provided; assumed public domain.
+
+rerun partially based on code from Shotgun
+Copyright (c) 2009 Ryan Tomayko <tomayko.com/about>
+License as above (MIT open source).
View
24 README.md
@@ -18,12 +18,13 @@ to growl in addition to the console.
sudo gem install rerun
-or...
+If you want to use the latest version, grab it off Github:
gem sources -a http://gems.github.com/
sudo gem install alexch-rerun
-(The github way isn't working yet for some reason. Maybe I have to wait for cron to run or something.)
+I'll bump the version on Github for release candidates, and deploy to
+Rubyforge only when it's had some time to bake.
# Usage:
@@ -35,10 +36,9 @@ app.rb:
rerun app.rb
Or if you're running a Rack app that's configured in config.ru
-but you want to override its port:
+but you want it on port 4000 and in debug mode:
- rerun "thin start --port=4000 -R config.ru"
-
+ rerun "thin start --debug --port=4000 -R config.ru"
# Options:
@@ -80,12 +80,14 @@ YMMV!
# Why did you write this?
-I've been using [Sinatra](http://sinatrarb.com) and loving it. In
-order to simplify their system, the Rat Pack just took out
-auto-reloading. I approve of this: a web application framework should
-be focused on serving requests, not on munging Ruby ObjectSpace. But
-I still wanted automatic reloading during development. Shotgun wasn't
-working for me (see above) so I spliced Rerun together out of .
+I've been using [Sinatra](http://sinatrarb.com) and loving it. In order
+to simplify their system, the Rat Pack just removed auto-reloading from
+Sinatra proper. I approve of this: a web application framework should be
+focused on serving requests, not on munging Ruby ObjectSpace for
+dev-time convenience. But I still wanted automatic reloading during
+development. Shotgun wasn't working for me (see above) so I spliced
+Rerun together out of code from Rspactor, FileSystemWatcher, and Shotgun
+-- with a heavy amount of refactoring and rewriting.
# Credits

0 comments on commit bdb0702

Please sign in to comment.