From b170010862d1bce8d227a8d86c478f53db9a0ebc Mon Sep 17 00:00:00 2001 From: Matthias Tischler Date: Thu, 31 Aug 2023 14:37:44 +0200 Subject: [PATCH] added information about the need for Microsoft Build Tools --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e04daea..e8f4e02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,13 +36,16 @@ for using [MkDocs](https://www.mkdocs.org): 1. Download and [install Python](https://www.python.org/) (NI recommends 3.8 or later) -2. (Optional) Create a virtual environment named `.venv` in the current +2. Download and [install Microsoft Build Tools for C++](https://visualstudio.microsoft.com/de/visual-cpp-build-tools/) + - MSVC C++ Build Tools + - Windows SDK +3. (Optional) Create a virtual environment named `.venv` in the current directory by running `python -m venv .venv`. Each time you open a new command window, activate the environment before running `mkdocs` commands: - Windows users: run `.venv\Scripts\activate` - Linux or Mac users: run `source .venv/bin/activate` -3. Upgrade pip by running `python -m pip install --upgrade pip` -4. Install dependencies by running `pip install -r requirements.txt` +4. Upgrade pip by running `python -m pip install --upgrade pip` +5. Install dependencies by running `pip install -r requirements.txt` For more information and installation options, see [MkDocs - Installation](https://www.mkdocs.org/#installation).