Release from gh (#16)

* 🐛 trigger run on GitHub release

* 🔧 change to 3.10 as 3.9 is out of life

* 🎨 format and update to package details

- reflect changes made in documentation of
 template logic
- format document (remove trailing spaces, fix line breaks)

* 📝 some more instructions

* 📝 add development tooling commands

Author: enryH

.github/workflows/cicd.yml

@@ -5,10 +5,13 @@ name: Python application
 
 on:
   push:
+    branches: ["main"]
   pull_request:
     branches: ["main"]
   schedule:
     - cron: "0 2 * * 3"
+  release:
+    types: [published]
 
 permissions:
   contents: read
@@ -41,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}

README.md

@@ -20,6 +20,10 @@ You will need to find and replace occurences of
   and [Creative Commons](https://creativecommons.org/chooser/).
   Replace [`LICENSE`](LICENSE) file with the license you choose.
 - Update the `CITATION.cff` file with your information.
+- once you change the code under `src`, please make sure to update
+  - `docs/tutorial/tutorial.ipynb` (add your usage example)
+  - `tests/test_mockup.py` (delete file and add your own tests following the
+    naming conventions `test_<filename>.py`)
 
 ## Development environment
 
@@ -29,6 +33,19 @@ Install package so that new code is picked up in a restared python interpreter:
 pip install -e ".[dev]"
 ```
 
+Then you want to run locally the commands which are check in the CI/CD pipeline 
+(using GitHub Actions). You can type
+
+```bash
+# run unittests
+pytest tests
+# format code and sort imports
+black .
+isort .
+# lint code and check for obvious errors
+ruff check src
+```
+
 ## Basic usage
 
 > works using this template