From 661225d0e41003237ef31f3997e630e384e7dad9 Mon Sep 17 00:00:00 2001 From: nilsding Date: Fri, 1 Aug 2014 11:34:02 +0200 Subject: [PATCH] markdownified readme --- README.rdoc => README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) rename README.rdoc => README.md (91%) diff --git a/README.rdoc b/README.md similarity index 91% rename from README.rdoc rename to README.md index dd4e97e2..23566ca4 100644 --- a/README.rdoc +++ b/README.md @@ -1,4 +1,4 @@ -== README +# README This README would normally document whatever steps are necessary to get the application up and running. @@ -6,23 +6,15 @@ 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 -rake doc:app. +`rake doc:app`.