Skip to content

Commit

Permalink
docs: add venv info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
riverKanies authored and thunderbiscuit committed Oct 3, 2024
1 parent 019ed13 commit c716146
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ We use [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material) to rende

To develop locally, you'll need to install `mkdocs-material`:

First you'll likely want to open a python virtual environment (since python environment management can be truly nightmarish otherwise). Doing so will depend on your OS.

Here's an example using [venv](https://docs.python.org/3/library/venv.html) on MacOS. Set up a virtual environment if you don't already have one:
```shell
mkdir ~/.venv
python3 -m venv ~/.venv
```
Then start the virtual environemnt:
```shell
source ~/.venv/bin/activate
```

Then you're ready to install:

```shell
pip install mkdocs-material
```
Expand Down

0 comments on commit c716146

Please sign in to comment.