From fdda1d309b13aed43bd1c835c751fb2ebc555337 Mon Sep 17 00:00:00 2001 From: benoit Date: Fri, 13 Aug 2021 12:12:08 +0200 Subject: [PATCH] Update README.md with install notes --- README.md | 10 ++++++++++ doc/make_readme.sh | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index e253864..fa7185f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,16 @@ Commands: node_tl_has_changed Check if the timeline has changed. ``` +## install + +Clone the repo, then install with pip from it : + +``` +pip install . +pip install .[dev] +pip install .[test] +``` + ## config file All global and service specific parameters can be specified via a config file has follows: diff --git a/doc/make_readme.sh b/doc/make_readme.sh index f4f1b33..9582bdd 100755 --- a/doc/make_readme.sh +++ b/doc/make_readme.sh @@ -18,6 +18,16 @@ cat << '_EOF_' > $README _EOF_ helpme cat << '_EOF_' >> $README +## install + +Clone the repo, then install with pip from it : + +``` +pip install . +pip install .[dev] +pip install .[test] +``` + ## config file All global and service specific parameters can be specified via a config file has follows: