Python tool for converting files and office documents to Markdown.
Update Python version requirement and add .cursorrules to .gitignore (#1249)
一I38261fd31ca9
diff --git a/.gitignore b/.gitignoreindex 7f0de2ba..aa4abd38 100644--- a/.gitignore+++ b/.gitignore@@ -164,3 +164,4 @@ cython_debug/#.idea/src/.DS_Store.DS_Store+.cursorrulesdiff --git a/README.md b/README.mdindex 0433a669..4f109519 100644--- a/README.md+++ b/README.md@@ -39,6 +39,31 @@ responses unprompted. This suggests that they have been trained on vast amountsMarkdown-formatted text, and understand it well. As a side benefit, Markdown conventionsare 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+```+## InstallationTo install MarkItDown, use pip: `pip install 'markitdown[all]'`. Alternatively, you can install it from the source: