Skip to content

Add Windows activation instructions for virtual environment #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ElianThorne wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Windows activation instructions for virtual environment #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@ This site is built using [Material for MkDocs](https://squidfunk.github.io/mkdoc

### Development environment setup

1. Install python 3
2. Create a virtual-env:
**1. Install python 3**

**2. Create and activate a virtual-env:**
- *Linux/macOS:*
```bash
python -m venv virtual-env
source virtual-env/bin/activate
```
3. `pip install -r requirements.txt`
4. `mkdocs serve`
- *Windows:*
```bash
python -m venv virtual-env
virtual-env\Scripts\activate
```
**3. `pip install -r requirements.txt`**
**4. `mkdocs serve`**

### To add documentation for a new module

Expand Down