diff --git a/README.md b/README.md index 3083d9d..b3e1672 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,23 @@ But also in our hall of fame: Feel free to ask questions, enhancements and to contribute to this project! +## Development + +The project is managed with `hatch`. [Install `hatch`](https://hatch.pypa.io/1.9/install/#gui-installer) first. + +Run the tests: + +``` +hatch run test:test +hatch run style:check +``` + +Serve the documentation: + +``` +hatch run doc:serve +``` + ## Credits -- Logo by [max.icons](https://www.flaticon.com/authors/maxicons) \ No newline at end of file +- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)