diff --git a/README.md b/README.md index d2e39d5..6809ff0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # sp-hydra-veil-cli The `sp-hydra-veil-cli` command line interface is the reference implementation of the `sp-hydra-veil-core` library. + +## 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