From 97b2db188b09b9dca1ec4c07ee95eecd11af2426 Mon Sep 17 00:00:00 2001 From: Luke Kingland Date: Thu, 26 Sep 2024 17:25:38 +0900 Subject: [PATCH] improved documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c966ae38..72d58651 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,11 @@ Python as a network service. ## Development - install `poetry` via `pipx` -- install dependencies with `poetry install` - activate the virtual environment managed by poetry via `poetry shell` + Note that on some environments this command may cause collissions with + configured keyboard shortcuts. If there are problems, you can source + the environment variables from the autogenerated venv with: + `source $(poetry env info --path)/bin/activate` +- install dependencies into the activated environment with `poetry install` - run the example via `python cmd/fhttp/main.py` - deactivate the virtual environment with `exit`