Skip to content

Commit b27986c

Browse files
committed
Add clarification to README
This adds a clarification to the instructions in the README for running the website.
1 parent ecc65c3 commit b27986c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Before running the site locally, you need to have the following installed:
5151

5252
### Running the website
5353

54+
Before running the website, you'll need to first load the Python virtual environment in your current shell. To do this, type the following (depending on your shell):
55+
56+
- **Bash**, **zsh** (most common): `virtualenv venv; source venv/bin/activate`
57+
- **Fish**: `virtualenv venv; source venv/bin/activate.fish`
58+
- **Nu**: `virtualenv venv; source venv/bin/activate.nu`
59+
60+
You only need to do the above once per shell session. Then, pick one of the following:
61+
5462
1. **MkDocs in strict mode**: Use `mkdocs serve --strict` for a production-like environment.
5563
2. **MkDocs in normal mode**: Use `mkdocs serve` for a less strict, more forgiving environment, suitable for debugging.
5664

0 commit comments

Comments
 (0)