Added ReadMe to tests and tools folders.

john-hen · Nov 17, 2022 · 0078f26 · 0078f26
1 parent a1d35d8
commit 0078f26
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 7 deletions.
diff --git a/tests/ReadMe.md 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
@@ -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