diff --git a/README.md b/README.md index e69de29..5b0094d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,37 @@ +# README # + +This README would normally document whatever steps are necessary to get your application up and running. + + +### What is this repository for? ### + +* Quick summary +* Installation +* Version + + +### How can I build and create deb file ? ### + +Clone project and go to ahenk project folder, run command below +$ dpkg-buildpackage + + +### How do I get set up? ### + +* Summary of set up +* Configuration +* Dependencies +* Database configuration +* How to run tests +* Deployment instructions + +### Contribution guidelines ### + +* Writing tests +* Code review +* Other guidelines + +### Who do I talk to? ### + +* Repo owner or admin +* Other community or team contact