From 38261fd31ca9cac3b6972b7b200abfc04bc14c93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=80I?= <46012513+Wuhall@users.noreply.github.com> Date: Thu, 22 May 2025 01:47:29 +0800 Subject: [PATCH] Update Python version requirement and add .cursorrules to .gitignore (#1249) * update markdown * Update and install Python version suggestions * Update README with prerequisites. --------- Co-authored-by: Lucas Liu Co-authored-by: afourney --- .gitignore | 1 + README.md | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/.gitignore b/.gitignore index 7f0de2b..aa4abd3 100644 --- a/.gitignore +++ b/.gitignore @@ -164,3 +164,4 @@ cython_debug/ #.idea/ src/.DS_Store .DS_Store +.cursorrules diff --git a/README.md b/README.md index 0433a66..4f10951 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,31 @@ responses unprompted. This suggests that they have been trained on vast amounts Markdown-formatted text, and understand it well. As a side benefit, Markdown conventions are also highly token-efficient. +## Prerequisites +MarkItDown requires Python 3.10 or higher. It is recommended to use a virtual environment to avoid dependency conflicts. + +With the standard Python installation, you can create and activate a virtual environment using the following commands: + +```bash +python -m venv .venv +source .venv/bin/activate +``` + +If using `uv`, you can create a virtual environment with: + +```bash +uv venv --python=3.12 .venv +source .venv/bin/activate +# NOTE: Be sure to use 'uv pip install' rather than just 'pip install' to install packages in this virtual environment +``` + +If you are using Anaconda, you can create a virtual environment with: + +```bash +conda create -n markitdown python=3.12 +conda activate markitdown +``` + ## Installation To install MarkItDown, use pip: `pip install 'markitdown[all]'`. Alternatively, you can install it from the source: