From a4863117244b521edb43adb1d5eaf6574c68ee02 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Wed, 16 Jun 2021 23:59:14 -0300 Subject: README.md: Conform with assert-readme.sh --- README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81bf4ac..c5d7d7c 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,13 @@ Personal package repository for a variety of operating systems, mainly for packaging personal projects of mine and make it available for users and packagers. -See the list of packages in [`paku.json`][paku.json]. +See the list of packages in [`paku.json`]. + +[`paku.json`]: https://git.euandreh.xyz/package-repository/tree/paku.json -[paku.json]: https://git.euandreh.xyz/package-repository/tree/paku.json ## How to add this to different OSes + ### Guix Add this channel to your `~/.config/guix/channels.scm`: @@ -52,6 +54,38 @@ $ sudo apt-add-repository 'deb https://package-repository.euandreh.xyz/debian/ s ``` --> -## LICENSE -Packaging code licensed under AGPLv3+. +## Contributing + +For running the extra development-only checks, run: + +```shell +$ make dev-check +``` + +and for generating the documentation HTML and website, run: + +```shell +$ make public +``` + +Send contributions to the [mailing list] via [`git send-email`](https://git-send-email.io/). + + +## Links + +- [homepage](https://euandreh.xyz/package-repository/) +- [source code](https://git.euandreh.xyz/package-repository/) +- [bug tracking](https://euandreh.xyz/package-repository/TODOs.html) +- [mailing list] +- [CI logs](https://euandreh.xyz/package-repository/ci.html) +- [CHANGELOG](https://euandreh.xyz/package-repository/CHANGELOG.html) + +[mailing list]: https://lists.sr.ht/~euandreh/public-inbox?search=%5Bpackage-repository%5D + + +## License + +The code is licensed under [GNU Affero General Public License v3.0 or later][AGPL-3.0-or-later] (AGPL-3.0-or-later). + +[AGPL-3.0-or-later]: https://git.euandreh.xyz/package-repository/tree/COPYING -- cgit v1.2.3