README: initial

This commit is contained in:
Antoine Martin 2024-12-29 14:44:31 -05:00
commit b87c46f0cb
Signed by: forge
GPG key ID: D62A472A4AA7D541

63
README.md Normal file
View file

@ -0,0 +1,63 @@
# pmayaports
Upstream: https://ayakael.net/forge/pmayaports
## Description
This repository contains aports that are not yet merged in the official
PostmarketOS repository or dont adhere to pmOS polices. Packages are
automatically built using CI. Once built, they are deployed to a Forgejo
repository, making them available to apk.
Branches are matched to PostmarketOS releases.
## Repositories
You can browse all the repositories at https://ayakael.net/forge/pmayaports
Affixed to each repository description is the appropriate link for use in
`/etc/apk/repositories`.
#### Backports
```
https://ayakael.net/api/packages/forge/alpine/v24.12/pm-backports
```
Aports from the official pmOS repositories backported from master. This is only
available and kept up-to-date on latest stable release.
#### User
```
https://ayakael.net/api/packages/forge/alpine/edge/pm-user
```
Aports that have yet to be (or may never be) upstreamed to the official
aports.
## How to use
Add security key of the apk repository to your /etc/apk/keys:
```shell
cd /etc/apk/keys
curl -JO https://ayakael.net/api/packages/forge/alpine/key
```
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 Codeberg here:
https://codeberg.org/ayakael/pmayaports/issues
For packages that are in backports, 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.