Permalink
Browse files

Update Readme to be somewhat less useless.

  • Loading branch information...
1 parent 879479b commit 04a07e575c20ecb9b92a82b15b5c948d890baadf @xenph committed May 1, 2012
Showing with 48 additions and 2 deletions.
  1. +48 −2 README.rdoc
View
@@ -1,5 +1,51 @@
-== Welcome to Ignition
+What is Ignition?
+=================
-Ignition is a simple kickstarter clone for internal projects.
+In the simplest of terms, Ignition is a very basic crowd funding web application - a la Kickstarter. It allows users to create projects, for which others can vote on or pledge time to. It was written for managing internal projects at [BigCommerce](http://www.bigcommerce.com).
+
+Why would I want to use it?
+===========================
+
+Ignition is useful for companies or teams with 20% time, or another variant on the undirected employee time. Ignition allows employees to find projects that they are interested in helping come to fruition. Through an open source communication model it faciltates co-operation with out the need for central management.
+
+How do I install it?
+====================
+
+Prerequisites
+-------------
+
+To install Ignition you'll need the following tools;
+
+* [Git](http://git-scm.com/)
+* [Ruby 1.9.2+](http://www.ruby-lang.org/en/)
+* [Rails 3.2+](http://rubyonrails.org/)
+* [Bundler](http://gembundler.com/)
+
+Running locally
+---------------
+Ignition runs under the WebBrick server that comes as part of rails. If you are planning to use it for production, you'll want to use something like [Thin](http://code.macournoyer.com/thin/) instead.
+
+```bash
+git clone git@github.com:xenph/ignition.git
+cd ignition
+bundle install
+rake db:migrate
+rails server
+```
+
+Running on Heroku
+-----------------
+
+The [Heroku](http://heroku.com) documentation has a very good entry on [setting up a Rails 3 application](https://devcenter.heroku.com/articles/rails3), but the basics are as follows;
+
+```bash
+git clone git@github.com:xenph/ignition.git
+cd ignition
+gem install heroku
+heroku login
+bundle install
+heroku create --stack cedar
+git push heroku master
+```

0 comments on commit 04a07e5

Please sign in to comment.