yujunjun/markitdown
1
0
Fork 0
mirror of https://github.com/microsoft/markitdown.git synced 2025-06-26 22:00:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'gagb/improve-readme' into main

Browse Source
This commit is contained in:
gagb 2024-12-14 18:44:33 -08:00 committed by GitHub
commit 1aa4abe90f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -20,6 +20,14 @@ You can install `markitdown` using pip:
```python
pip install markitdown
```
or from the source
```sh
pip install -e .
```
# Usage
The API is simple:
@ -57,6 +65,27 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Installation
To install the dependencies for this project, run the following command in the root of the project:
## Running Tests
To run the tests for this project, use the following command:
```sh
pytest
```
## Running Pre-commit Checks
If there are pre-commit hooks configured (indicated by the `.pre-commit-config.yaml`), you can test them by running:
```sh
pre-commit run --all-files
```
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft