markdownified readme

This commit is contained in:
nilsding 2014-08-01 11:34:02 +02:00
parent 386066c55b
commit 661225d0e4
1 changed files with 2 additions and 10 deletions

View File

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