From f5e7ec02496b9ba8761d328106487524c3db1999 Mon Sep 17 00:00:00 2001 From: siddharth Date: Sun, 27 Jun 2021 00:44:27 -0400 Subject: README.md: update installation section Add documentation on how to use the repo version of `acmens`. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index d638a93..de469ea 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ It's meant to be run locally from your computer. * openssl or libressl * python3 * pip +* virtualenv (if you want to use the repo version) ## installation @@ -21,6 +22,26 @@ It's meant to be run locally from your computer. pip install acmens ``` +Or, if you would like to use the repo version: + +```sh +cd /path/to/acmens + +# init virtual environment +make venv + +# activate virtual environment +. .venv/bin/activate + +# put acmens in your PATH +make develop +# note that any changes you make to acmens.py will be instantly reflected +# in the acmens in your PATH. + +# de-activate the virtual environment: +deactivate +``` + ## getting/renewing a certificate First, generate an user account key for Let's Encrypt: -- cgit v1.2.3