-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Currently, the README.md file describes an old version of the project. The main points to change are:
- Installation:
- installation now should be done preferably using
poetry - the files requirements.txt, requirements-dev.txt and requirements-scripts.txt no longer exist or are no longer used
- the command
python setup.py installwill no longer work since there is no file setup.py
- installation now should be done preferably using
- Contributing:
poetry installshould be enough to install the necessary development dependencies - Making changes: the preferable way of running tests and coverage check is running
make testandmake coverage - Committing: the current way of committing is by running
make commit - Releasing new versions: to release a new version automatically, the recommended way is running
make release - Upcoming: I should probably include a "how to use" section
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation