doc: add some useful information

fgcz · Aug 13, 2024 · 45418ac · 45418ac
1 parent 5cf90d3
commit 45418ac
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/contribute.md b/docs/contribute.md
@@ -29,3 +29,15 @@ mkdocs serve
 # To publish after changes
 mkdocs gh-deploy
 ```
+
+## Release
+
+To create a release, increase the version in `pyproject.toml`, prepare `changelog.md`,
+commit everything and run `release.py`. This script will
+
+- Create a tag and push it to GitHub
+- Merge the changes to the `stable` branch and push it to GitHub
+- Build the documentation and push it to GitHub Pages
+
+The only manual step that remains is creating a release on GitHub.
+To do so, you can paste the changelog section of the release and create a new release on GitHub using the tag that was created.
diff --git a/docs/index.md b/docs/index.md
@@ -31,6 +31,14 @@ dependencies = [
 ]
 ```
 
+## Updating
+
+If you installed with `pipx`, you can update the package to the most recent release with the following command:
+
+```bash
+pipx upgrade bfabric
+```
+
 ## Configuration
 
 Create a file as follows: (note: the password is not your login password, but the web service password available on your profile page)