Improve Virtual Env Activation Instructions for Windows (#1082)

This update enhances the CONTRIBUTING.md guide by providing clear, separate instructions for activating the Python virtual environment on Windows, tailored for both Command Prompt and PowerShell users. Previously, the guide only included a generic command, which might not work across different shells without slight modifications. This change aims to make the setup process more accessible and straightforward for contributors using Windows, ensuring they have the correct commands for their specific environment. By reducing potential setup hurdles, we hope to streamline the initial contribution process for new developers.
This commit is contained in:
Lawyered
2024-02-21 20:15:23 -05:00
committed by GitHub
parent 0e4677e3db
commit 76092a5cf0

View File

@@ -72,11 +72,13 @@ For convenience here's a command for it:
python -m venv .venv python -m venv .venv
source .venv/bin/activate source .venv/bin/activate
``` ```
_For Windows activate via:_ _For Windows, activate the virtual environment using Command Prompt:_
```bash ```bash
.venv\Scripts\activate .venv\Scripts\activate
``` ```
If using PowerShell, the command slightly differs:
```powershell
.venv\Scripts\Activate.ps1
Install the required python dependencies: Install the required python dependencies:
```bash ```bash
pip install -r danswer/backend/requirements/default.txt pip install -r danswer/backend/requirements/default.txt