From 2d7ae9d60dc163927ee63b4b138edba477da29bd Mon Sep 17 00:00:00 2001 From: "Winzlieb (aider)" Date: Mon, 25 Nov 2024 11:21:35 +0100 Subject: [PATCH] docs: Add Python venv instructions to Development section in README --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8407d7..255c976 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,9 @@ nix run .#vision-assistant -L ### Development Environment -For development work, enter the development shell: +#### Using Nix + +For development work using Nix, enter the development shell: ```bash # Enter development environment @@ -81,6 +83,24 @@ welcome vision-assistant ``` +#### Using Python venv + +Alternatively, you can use Python's virtual environment: + +```bash +# Create and activate virtual environment +python -m venv .venv +source .venv/bin/activate + +# Install the package in editable mode +pip install -e . + +# Run components +python -m portal.main +python -m welcome.main +python -m vision_assistant.main +``` + ### Development Tools Several utilities are available to help with development: