From 7d043001b956fb80116cf8eedcca1d5aaf2edbd4 Mon Sep 17 00:00:00 2001
From: Dimitri Staessens <dimitri@ouroboros.rocks>
Date: Sat, 7 Mar 2026 22:46:56 +0100
Subject: build: Use git tags for versioning

Replace setup.py metadata with pyproject.toml and derive version from
git tags with setuptools-scm. Adds git archive support for
setuptools-scm version detection.
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'README.md')

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.
-- 
cgit v1.2.3