Update README

This commit is contained in:
Antoine Martin 2024-08-10 11:27:01 -04:00
parent c37dc3bb6d
commit 37baebabb0
Signed by: forge
GPG key ID: D62A472A4AA7D541

72
README.md Normal file
View file

@ -0,0 +1,72 @@
# repo-apk
Upstream: https://ayakael.net/forge/repo-apk.git
## DEPRECATION
This repo is now deprecated, and has been moved to https://ayakael.net/forge/repo-apk.git. Please adjust your `/etc/repositories` accordingly.
## Description
This repository contains build artifacts from https://lab.ilot.io/ayakael/user-aports
Branches are matched to Alpine releases.
## Repositories
You can browse all the repositories at https://ayakael.net/forge/repo-apk.git
Affixed to each repository description is the appropriate link for use in
`/etc/apk/repositories`.
#### Backports
```
https://ayakael.net/forge/repo-apk/media/branch/v3.17/backports
```
Aports from the official Alpine repositories backported from.
#### Cross
```
https://ayakael.net/forge/repo-apk/media/branch/v3.17/cross
```
Aports required for cross-compiling from `x86_64` to other arches.
#### User
```
https://ayakael.net/forge/repo-apk/media/branch/v3.17/user
```
Aports that have yet to be (or may never be) upstreamed to the official
aports.
## How to use
Add security key of this repository to your /etc/apk/keys:
```shell
cd /etc/apk/keys
wget https://ayakael.net/forge/repo-apk/raw/branch/v3.20/antoine.martin@protonmail.com-5b3109ad.rsa.pub
```
Add repositories that you want to use (see above) to `/etc/apk/repositories`.
## Support
Generally, only the latest branch is kept up-to-date. That said, if an aport
is broken on the latest release due to a dependency incompatibility, it will be
kept up-to-date on the release it last works on.
As these aports are built for my own application, I make no guarantees that
they will work for you.
## Contribution & bug reports
If you wish to contribute to this aports collection, or wish to report a bug,
you can do so on Alpine's GitLab instance here:
https://gitlab.alpinelinux.org/ayakael/user-aports
For packages that are in testing/community, bug reports and merge requests
should be done on Alpine's aports repo instance:
https://gitlab.alpinelinux.org/alpine/aports
## License
This readme, abuilds and support scripts are licensed under MIT License