From fca3cefb59645e35f8f95ef59e4fc7d2ecbd74c9 Mon Sep 17 00:00:00 2001 From: Thor77 Date: Mon, 12 Nov 2018 14:05:56 +0100 Subject: [PATCH] Add installation and diagram generation instructions --- README.md | 35 +++++++++++++---------------------- 1 file changed, 13 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7db80e4..eb8dc9d 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,15 @@ -# README +# turniere-backend +Ruby on Rails application serving as backend for turnie.re -This README would normally document whatever steps are necessary to get the -application up and running. +# Installation +``` +# install dependencies +$ bundle install +# run migrations +$ rails db:migrate +``` -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 - -* ... +# Generate diagrams +``` +rails diagram:all_with_engines +```