Update README.md
This commit is contained in:
parent
f3298856ed
commit
2a38d0b0d9
1 changed files with 31 additions and 0 deletions
31
README.md
31
README.md
|
|
@ -1,3 +1,34 @@
|
||||||
# sp-hydra-veil-core
|
# sp-hydra-veil-core
|
||||||
|
|
||||||
The `sp-hydra-veil-core` library exposes core logic to higher-level components.
|
The `sp-hydra-veil-core` library exposes core logic to higher-level components.
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue