From 117ee6b6983507bea632125d863cdcd87de0d9b7 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Wed, 8 Dec 2021 20:19:33 +0200 Subject: [PATCH] README.md: add usage instructions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 3581c47..80b283a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,19 @@ You can try [the hosted version](https://fierce-ocean-30836.herokuapp.com) or host it yourself (see below). +## Usage +Create a Python 3.7+ virtual environment and install the dependencies: + + $ python3 -m venv venv + $ source venv/bin/activate + $ pip install -r requirements.txt + +## Running Locally + + $ gunicorn csv_metadata_quality_web.main + +And then visit http://localhost:8000/ in your browser. + ## License This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).