Add a simple README file

This commit is contained in:
Petko Bordjukov 2014-07-28 13:23:14 +03:00
parent 3069a857fb
commit 7cb954d9c7
2 changed files with 11 additions and 28 deletions

11
README.md Normal file
View File

@ -0,0 +1,11 @@
Clarion
=======
A CfP automation system for OpenFest.
Installation
------------
1. `git clone https://github.com/ignisf/clarion.git`
2. Run `bundle install; bin/rake bootstrap`
3. You can now run the rails server with `bin/rails s`

View File

@ -1,28 +0,0 @@
== README
This README would normally document whatever steps are necessary to get the
application up and running.
Things you may want to cover:
* Ruby version
* System dependencies
* Configuration
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.