From 40d5a39de61fde6f628e879bf1411319a68970f3 Mon Sep 17 00:00:00 2001 From: Romeo Kienzler <5694071+romeokienzler@users.noreply.github.com> Date: Wed, 10 Sep 2025 20:48:59 +0200 Subject: [PATCH] Update README with installation and build instructions Added installation and build instructions for the CLAIMED package. Signed-off-by: Romeo Kienzler --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 259856d2..953a4e95 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,21 @@ For more information, please visit the project's [website](https://claimed-frame CLAIMED is supported by the EU’s Horizon Europe program under Grant Agreement number 101131841 and also received funding from the Swiss State Secretariat for Education, Research and Innovation (SERI) and the UK Research and Innovation (UKRI). +# Install + +```bash +pip install claimed +``` + +This package installs the [CLAIMED Component Library (CCL)](https://pypi.org/project/claimed/), [CLAIMED Component Compiler (C3)](https://pypi.org/project/claimed-c3/) and the [CLAIMED CLI tool](https://pypi.org/project/claimed-cli/) which can be used to run operators locally. + + +# Build & Publish +```bash +python -m build # might require a 'pip install build' +python -m twine upload --repository pypi dist/* # might require a 'pip install twine' +rm -r dist +``` + +