diff --git a/README.md b/README.md index 0f7de44..cd51e60 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,22 @@ To install it: **NOTE:** if you are using an Apple M1, please make sure to update *coincurve* (required by *bip_utils*) to version 17.0.0 otherwise it won't work. -To run tests: +# Test and Coverage - python -m unittest discover +Install develop dependencies: -Or you can install *tox*: + pip install -r requirements-dev.txt - pip install tox +To run tests: -And then simply run it: + python -m unittest discover - tox +To run tests with coverage: -This will run code coverage with different Python versions and perform style and code analysis.\ -For quick test: + coverage run -m unittest discover + coverage report - tox -e unittest +To run code analysis, just execute the `analyze_code` script. # Modules description