diff --git a/README.md b/README.md index faf5b98..6fdb362 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ **Want to contribute?** - Clone this repo +- Install requirements: `pip install -r requirements.txt` - Run the server: - `mkdocs serve` - Specify a port: `mkdocs serve -a localhost:8001` diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index b458bb3..ac2d22e 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -59,9 +59,14 @@ This will create a Python virtual environment and install various other requirem To use the virtual environment, you need to activate it. This needs to be done for each new terminal session and is done by running: +Linux/macOS: ```bash source venv/bin/activate ``` +Windows (PowerShell): +```powershell +venv\Scripts\Activate +``` ## Run `esphome`