Permalink
Browse files

initial readme

  • Loading branch information...
1 parent 3456b30 commit 9446500006c8d3f8e565fcae2b6ad03fa36d31c2 @hone hone committed Sep 21, 2011
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
View
@@ -0,0 +1,19 @@
+# Ruby Language Pack
+
+The Ruby Language Pack requires a `Gemfile` and `Gemfile.lock` file to be recognized as a ruby app. It will then proceed to run `bundle install` after setting up the appropriate environment for [ruby](http://ruby-lang.org) and [bundler](http://gembundler.com).
+
+## Bundler
+
+For non-windows `Gemfile.lock` files, the `--deployment` flag will be used. The `vendor/bundle` directory is cached between builds to allow for faster `bundle install` times. `bundle clean` is used to ensure no stale gems are stored between builds.
+
+## Rails
+
+A [rails_log_stdout](http://github.com/ddollar/rails_log_stdout) is installed by default so Rails' logger will log to STDOUT and picked up by Heroku's [logplex](http://github.com/heroku/logplex).
+
+## Rails 3
+
+To enable static assets being served on the dyno, [rails3_serve_static_assets](http://github.com/pedro/rails3_serve_static_assets) is installed by default. If the [execjs gem](http://github.com/sstephenson/execjs) is detected then [node](http://github.com/joyent/node) will be vendored. The `assets:precompile` rake task will get run if no `public/manifest.yml` is detected. See [this article](http://devcenter.heroku.com/articles/rails31_heroku_cedar) on how rails 3.1 works on cedar.
+
+## Auto Injecting Plugins
+
+Any vendored plugin can be stopped from being installed by creating the directory it's installed to in the slug. For instance, to prevent rails_log_stdout plugin from being injected, add `vendor/plugins/rails_log_stdout/.gitkeep` to your git repo.

0 comments on commit 9446500

Please sign in to comment.