Skip to content

Commit

Permalink
Improve the readme with contributing guidelines
Browse files Browse the repository at this point in the history
Addresses issue #6

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/microsoft/markitdown?shareId=XXXX-XXXX-XXXX-XXXX).
  • Loading branch information
gagb committed Dec 12, 2024
1 parent b401396 commit 3f9ba06
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,30 @@ 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 [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Installation

To install the dependencies for this project, run the following command in the root of the project:

```sh
pip install -e .
```

## 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
Expand Down

0 comments on commit 3f9ba06

Please sign in to comment.