From fd09d1ea331a90aac1907523fbff743d8a2a0b64 Mon Sep 17 00:00:00 2001 From: nek0 Date: Tue, 7 Apr 2015 02:21:05 +0200 Subject: [PATCH] readme update --- README.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c9f1f96..56d7b08 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,37 @@ -# yammat +#yammat Yet Another MateMAT -## Introduction +##Introduction -This project aims to be an implementation for a trust based POS for hackerspaces +This project aims to be an implementation for a trust based POS for hackerspaces. + +##Dependencies + +###External dependencies + +In order to build yammat you need the packages `cabal-install`, `ghc` and `postgresql`. Furthermore you need the Haskell packages `alex` and `happy`. To install these enter `cabal install alex happy` into your command line. + +###Internal dependencies + +All internal dependencies are in the file `yammat.cabal` and will be installed automagically with the command `cabal install --only-dependencies`. + +##Building + +To build this project enter `cabal configure && cabal build` into your command line + +##Deployment + +Copy or link the executable `dist/build/yammat/yammat` to your desired run location alongside with the folders `static` and `config`. The Folders should be copied, or you will get problems with your git pulls. + +##Configuration + +Check the configuration File `config/settings.yml`. Create Postgresql Databases according to these settings. + +##Lift-Off + +Run `./yammat config/settings.yml` in your desired run location. + +For better control You can wrap an init script around this. How to do this is described [in my blog][blog]. + +[blog]: http://nek0.eu/posts/2014-10-23-Daemonize-a-yesod-app.html