diff --git a/tests/ReadMe.md b/tests/ReadMe.md new file mode 100644 index 0000000..155c8b3 --- /dev/null +++ b/tests/ReadMe.md @@ -0,0 +1,5 @@ +## Test suite + +The scripts here, along with the fixtures, constitute the test suite. +Run them with `pytest` from the root folder. Or use the scripts +`test.py` and `coverage.py` from the `tools` folder. diff --git a/tools/ReadMe.md b/tools/ReadMe.md new file mode 100644 index 0000000..c5036cf --- /dev/null +++ b/tools/ReadMe.md @@ -0,0 +1,18 @@ +## Developer tools + +These are simple helper scripts to run the various dev tools, such as +pyTest or Flit. See the doc-strings of the individual scripts for +details. + +For local development, install the package in editable mode inside a +dedicated virtual environment: `pip install --editable .[dev]`. + + +### Releasing a new version + +* Bump version number in `meta.py`. +* Add dedicated commit for the version bump. +* Tag commit with version number, e.g. `git tag 1.0.0`. +* Push to GitHub: `git push && git push --tags`. +* Create GitHub release from tag and add release notes. +* Publish to PyPI: `tools/publish.py`. diff --git a/tools/release.md b/tools/release.md deleted file mode 100644 index 128c43f..0000000 --- a/tools/release.md +++ /dev/null @@ -1,7 +0,0 @@ -Steps to take when releasing a new version: -* Bump version number in `meta.py`. -* Add dedicated commit for the version bump. -* Tag commit with version number, e.g. `git tag 1.0.0`. -* Push to GitHub: `git push && git push --tags`. -* Create GitHub release from tag and add release notes. -* Publish to PyPI: `tools/publish.py`.