Skip to content

Commit

Permalink
docs: add development section
Browse files Browse the repository at this point in the history
  • Loading branch information
brunoarine committed Jun 29, 2023
1 parent dc24148 commit 39f9f53
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Features:
- [Usage](#usage)
- [Options](#options)
- [Example](#examples)
- [Development](#development)
- [License](#license)

## Prerequisites
Expand Down Expand Up @@ -136,6 +137,26 @@ To print the results table as a Markdown list:
findlike -H "# List of similar documents" -p "- " reference_file.txt
```

## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

```bash
cd findlike
python -m venv venv
source venv/bin/activate
```

Now install the development dependencies:

pip install -e '.[dev]'

To run the tests:

```bash
pytest
```

## License

This project is licensed under the terms of the MIT license. See [LICENSE](LICENSE) for more details.

0 comments on commit 39f9f53

Please sign in to comment.