From 4c466f427709eb417448dc40ebf85902d1e60254 Mon Sep 17 00:00:00 2001 From: Jeremy McAnally Date: Tue, 10 Apr 2012 11:45:58 -0400 Subject: [PATCH] Better README --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fbe336..7ec95da 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ # Railcar -Real README coming soon...I promise. ;) \ No newline at end of file +Railcar is a fully isolate Rails development environment. The application itself is developed in MacRuby using XCode and Interface Builder. On first run, it will bootstrap itself with: + +* An isolated, Railcar-owned installation of Homebrew +* RbEnv through Homebrew +* Ruby 1.9.3-p125 through RbEnv +* Sqlite through Homebrew +* Rails 3.2 (or whatever the latest release currently is) + +These installations are isolated from your system installs, so if you're already using Homebrew, RVM, RbEnv, etc. then it won't mess with anything. + +## Requirements + +* Mac OS X 10.6+ +* A C compiler (currently; we are working on changing that). Acceptable options: + * XCode + * Apple's command line tools downloadable from the Developer Center (GCC without XCode basically) + * GCC installer package from here: [https://github.com/kennethreitz/osx-gcc-installer](https://github.com/kennethreitz/osx-gcc-installer) + * GCC installed via Homebrew + +## Usage + +(Coming soon) + +## Get Involved + +How can you get involved? There are a few ways: + +* **Contribute code.** There are a few `TODO` notes throughout the code, and you can find any bugs or issues filed here: [https://github.com/arcturo/Railcar/issues](https://github.com/arcturo/Railcar/issues) +* **Contribute documentation.** A nice wiki page with a quick tutorial about setting the app up and getting your first application generated and launched would be great. Really anything! Send pull requests for this README or add to the wiki here: [https://github.com/arcturo/Railcar/wiki](https://github.com/arcturo/Railcar/wiki) +* **Contribute funding.** People have asked, so here it is. If you'd like to contribute some funding, [click here](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EUPXCZ5XKWX86). If you hate PayPal, just e-mail me. We'll figure something out. + +## Contributors and Supporters + +* Jeremy McAnally ([jm](http://github.com/jm)) - Initial proof of concept and app development +* [justinmcp](http://github.com/justinmcp) - [Fixed a minor bug with requires](https://github.com/arcturo/Railcar/pull/4)