Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Actually use Rdoc syntax in the readme.
- Loading branch information
Showing
1 changed file
with
30 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,42 @@ | ||
| What is Ignition? | ||
| ================= | ||
| = Ignition | ||
|
|
||
| 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? | ||
| =========================== | ||
| == 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? | ||
| ==================== | ||
| == How do I install it? | ||
|
|
||
| Prerequisites | ||
| ------------- | ||
| === 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 | ||
| ``` | ||
| * {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. | ||
|
|
||
| $ 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; | ||
|
|
||
| $ 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 | ||
|
|
||
|
|