From f913d8a082091a1bc0d0c41380a976f88b37c294 Mon Sep 17 00:00:00 2001 From: codeking Date: Tue, 24 Mar 2026 18:01:18 +0100 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 4cbce60..90db3ac 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # sp-essentials The `sp-essentials` library provides essential logic to downstream projects. + +## Build Instructions + +### Presumptions + +* Your system is configured to use the Simplified Privacy package registry [1]. + +### Prerequisites + +* `build` +* `twine` + +To install them, activate your `venv`, if necessary, and run: + +```bash +pip install build twine +``` + +### Build Steps + +* Activate your `venv`, if necessary, and run: + +```bash +rm -rf ./dist/* +python3 -m build +python3 -m twine upload --repository forgejo ./dist/* +``` + +--- + +[1] https://forgejo.org/docs/v14.0/user/packages/pypi/#configuring-the-package-registry