From 6f8d9247c4e499469fc73a2c5388d96eedb938d8 Mon Sep 17 00:00:00 2001 From: Yohan Boniface Date: Tue, 9 Apr 2019 19:05:02 +0200 Subject: [PATCH] A bit more README --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e935012..3f1e50e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,35 @@ # Copanier -Gestion de commande groupée minimaliste. +Minimalist grouped command management +# Local install -# Installation - -Dépendances: +Dependencies: - python >= 3.7 + + +- Create a venv: + + python -m venv path/to/venv + +- Activate it: + + source path/to/venv/bin/activate + +- Install python package locally + + python setup.py develop + + +## Run local server + +Make sure venv is active, then: + + copanier serve + +Optionally autoreload the server when you change a python file (needs `hupper`): + + copanier serve --reload + +Then browse to http://localhost:2244