Document how to install dependencies in README.md

terrencepreilly / darglint

A python documentation linter which checks that the docstring description matches the definition.

MIT License

482 stars 41 forks source link

Document how to install dependencies in README.md #129

Closed mathPi closed 4 years ago

mathPi commented 4 years ago

Hi, I tried to run the tests following the contribution documentation. I had an issues saying that flake8 is missing. It was because the dev dependencies were not installed. So I added in the readme how to install them using poetry.

Maybe an other solution would be to document how to install them using tox, like it is done by travis.

terrencepreilly commented 4 years ago

Good point. This section does need to be updated pretty badly. Thanks!