From 4a07d0c828e11ca3600fe38ad7346e64466e662f Mon Sep 17 00:00:00 2001 From: Abhinav Sarkar Date: Fri, 18 Dec 2015 14:00:18 +0530 Subject: [PATCH] Adds setup instructions to the README. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd8cc10..fdf8d72 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # ringo -Tool to transform OLTP database schemas to OLAP database schemas automatically + A tool to transform Postgres OLTP database schemas to OLAP database schemas automatically. + +## Setup instructions +- Install stack from http://haskellstack.org. +- Git clone this repository: + + ```sh + > git clone https://github.com/quintype/ringo + ``` +- Run the following commands in the terminal: + + ```sh + > cd ringo + > stack setup + > stack install + ``` +- Add `~/.local/bin/` to your shell's PATH. +- You should be able to run the command `ringo` on terminal now. Run `ringo -h` to see the help.