codeforleipzig/stadtratmonitor
codeforleipzig/stadtratmonitor
1
1
Fork 0
mirror of https://github.com/CodeforLeipzig/stadtratmonitor.git synced 2024-12-22 23:53:15 +01:00
Code Issues Projects Releases Packages 4 Wiki Activity

Update and rename README.rdoc to README.md

Browse source
This commit is contained in:
Andreas Haller 2015-05-19 09:49:07 +02:00
parent 72b3fc5672
commit 20a66e639e
2 changed files with 11 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md Normal file
View file

@ -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

28
README.rdoc
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>.