Update README.md

This commit is contained in:
codeking 2026-03-24 15:50:21 +01:00
parent 1b86258ac0
commit fb4d9d6060

View file

@ -1,3 +1,30 @@
# sp-hydra-veil
The `sp-hydra-veil` meta repository connects client revisions to explicit versions of subcomponents.
## Build Instructions
### Presumptions
* The correct versions of all direct, and indirect, dependencies were built and submitted to Simplified Privacy's package registry.
### Prerequisites
* Ensure `docker` (version `29.3.0` or higher) is installed on your system.
* Mark the desired direct dependency versions inside the `requirements.txt` file.
* Assign a version number to your `AppImage` build inside the `VERSION` file.
### Build Steps
* From within the project's root directory, run:
```bash
docker compose up --force-recreate
```
* Once the `AppImage` has been successfully built, run:
```bash
sed -z -i 's/Hydra_Veil/hydra-veil/g' dist/Hydra_Veil-x86_64.AppImage.zsync
rename -d 's/^Hydra_Veil/hydra-veil/' dist/Hydra_Veil*
```