aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 96e6151..0d57a5e 100644
--- a/README.md
+++ b/README.md
@@ -388,5 +388,16 @@ unbind_process(pid, "my_name")
Some example code is in the examples folder.
+## Versioning
+
+pyOuroboros uses `setuptools_scm` to derive its version from git tags.
+
+**Compatibility contract across Ouroboros repositories:**
+
+| Scope | Rule |
+|---|---|
+| ouroboros (C) ↔ pyouroboros / rumba | Shared `major.minor` — pyouroboros requires at least the same ouroboros `major.minor` |
+| pyouroboros ↔ rumba ↔ ouroboros-integration | Strict lockstep `major.minor.patch` — always released together |
+
## License
pyOuroboros is LGPLv2.1. The examples are 3-clause BSD.