Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down