readme update

This commit is contained in:
nek0 2015-04-07 02:21:05 +02:00
parent bef1ade018
commit fd09d1ea33

View file

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