Skip to content

Commit

Permalink
docs: Add Python venv instructions to Development section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bastiion committed Nov 25, 2024
1 parent c861594 commit 2d7ae9d
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down

0 comments on commit 2d7ae9d

Please sign in to comment.