diff --git a/README.md b/README.md new file mode 100644 index 0000000..b76748f --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Stadtratmonitor + +## Setup + +1. Install Ruby, Bundler, Elasticsearch +1. Start Elasticsearch: `$ elasticsearch` +1. `$ bundle && bundle exec rake db:setup` +1. Start Rails server `$ bundle exec rails s` +1. Visit http://localhost:3000 + +TODOs: https://github.com/ahx/stadtratmonitor/issues diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e..0000000 --- a/README.rdoc +++ /dev/null @@ -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 -rake doc:app.