From bd193e2a84218e1468f9e4613e035def0d0cfcc6 Mon Sep 17 00:00:00 2001 From: Andrew Barnes Date: Sun, 31 May 2026 09:04:13 -0400 Subject: [PATCH] docs: add Windows venv activation instructions Document Windows PowerShell/cmd venv activation and adjust source install commands to be shell-agnostic. --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa2f58bb8..cb78e57f5 100644 --- a/README.md +++ b/README.md @@ -40,17 +40,49 @@ With the standard Python installation, you can create and activate a virtual env ```bash python -m venv .venv +``` + +Activate the environment: + +```bash +# macOS/Linux (bash/zsh) source .venv/bin/activate ``` +```powershell +# Windows (PowerShell) +.\.venv\Scripts\Activate.ps1 +``` + +```bat +:: Windows (cmd.exe) +.venv\Scripts\activate.bat +``` + If using `uv`, you can create a virtual environment with: ```bash uv venv --python=3.12 .venv +``` + +Activate the environment: + +```bash +# macOS/Linux (bash/zsh) source .venv/bin/activate # NOTE: Be sure to use 'uv pip install' rather than just 'pip install' to install packages in this virtual environment ``` +```powershell +# Windows (PowerShell) +.\.venv\Scripts\Activate.ps1 +``` + +```bat +:: Windows (cmd.exe) +.venv\Scripts\activate.bat +``` + If you are using Anaconda, you can create a virtual environment with: ```bash @@ -63,9 +95,9 @@ conda activate markitdown To install MarkItDown, use pip: `pip install 'markitdown[all]'`. Alternatively, you can install it from the source: ```bash -git clone git@github.com:microsoft/markitdown.git +git clone https://github.com/microsoft/markitdown.git cd markitdown -pip install -e 'packages/markitdown[all]' +pip install -e "packages/markitdown[all]" ``` ## Usage