update readme
parent
fa689bb7ba
commit
d3bc656fc1
20
README.md
20
README.md
|
@ -1,4 +1,22 @@
|
||||||
# Contentmatcher
|
# 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
|
## Try it
|
||||||
Usually there is a running instance [here](https://cm.kompot.si).
|
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
|
## Build instructions
|
||||||
Comming soon...
|
Comming soon...
|
||||||
|
|
Loading…
Reference in New Issue