From d3bc656fc18495d088bffc143c3a080db6a2b56c Mon Sep 17 00:00:00 2001 From: mknurs Date: Fri, 12 Aug 2022 20:17:55 +0200 Subject: [PATCH] update readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5cec5dd..10e21b0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ # Contentmatcher + +## Development quickstart + +Setup a database (...). Configure a `.env` file (see `.env.dist`) (...). + +Install dependencies with `pipenv`. + +``` +$ pipenv install +``` + +Run `app.py`. + +``` +$ python app.py +``` + + ## Try it Usually there is a running instance [here](https://cm.kompot.si). @@ -36,4 +54,4 @@ If you have any questions, feedback, ideas or if you would like contribute, plea ## Build instructions -Comming soon... \ No newline at end of file +Comming soon...