fix(doc): improve splitting topics across README.md and CONTRIBUTING.md
This commit is contained in:
parent
c214022300
commit
1b1aa7f738
@ -4,9 +4,36 @@ These are the contribution guidelines for archlinux-keyring.
|
|||||||
All code contributions fall under the terms of the GPL-3.0-or-later (see
|
All code contributions fall under the terms of the GPL-3.0-or-later (see
|
||||||
[LICENSE](LICENSE)).
|
[LICENSE](LICENSE)).
|
||||||
|
|
||||||
|
Please read our distribution-wide [Code of
|
||||||
|
Conduct](https://terms.archlinux.org/docs/code-of-conduct/) before
|
||||||
|
contributing, to understand what actions will and will not be tolerated.
|
||||||
|
|
||||||
|
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
|
||||||
|
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
|
||||||
|
|
||||||
Any merge request to the repository requires two approvals of authorized
|
Any merge request to the repository requires two approvals of authorized
|
||||||
approvers (the current main key holders).
|
approvers (the current main key holders).
|
||||||
|
|
||||||
|
## Discussion
|
||||||
|
|
||||||
|
Discussion around archlinux-keyring may take place on the [arch-projects
|
||||||
|
mailing list](https://lists.archlinux.org/listinfo/arch-projects) and in
|
||||||
|
[#archlinux-projects](ircs://irc.libera.chat/archlinux-projects) on [Libera
|
||||||
|
Chat](https://libera.chat/).
|
||||||
|
|
||||||
|
All past and present authors of archlinux-keyring are listed in
|
||||||
|
[AUTHORS](AUTHORS.md).
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
The following additional packages need to be installed to be able to lint
|
||||||
|
and develop this project:
|
||||||
|
|
||||||
|
* python-black
|
||||||
|
* python-isort
|
||||||
|
* flake8
|
||||||
|
* mypy
|
||||||
|
|
||||||
## Keyringctl
|
## Keyringctl
|
||||||
|
|
||||||
The `keyringctl` script is written in typed python, which makes use of
|
The `keyringctl` script is written in typed python, which makes use of
|
||||||
@ -14,33 +41,3 @@ The `keyringctl` script is written in typed python, which makes use of
|
|||||||
|
|
||||||
The script is type checked, linted and formatted using standard tooling.
|
The script is type checked, linted and formatted using standard tooling.
|
||||||
When providing a merge request make sure to run `make lint`.
|
When providing a merge request make sure to run `make lint`.
|
||||||
|
|
||||||
## Key directories
|
|
||||||
|
|
||||||
This repository contains PGP packet data, that describes the trusted signing
|
|
||||||
keys (below [main](main)) and the packager keys (below [packagers](packagers))
|
|
||||||
of the distribution.
|
|
||||||
|
|
||||||
Import of a new main key is done using
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./keyringctl import --main --name <username> <file>
|
|
||||||
```
|
|
||||||
|
|
||||||
Updates to existing main keys is done using
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./keyringctl import --main <file_or_directory>
|
|
||||||
```
|
|
||||||
|
|
||||||
Import of a new packager key is done using
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./keyringctl import --name <username> <file>
|
|
||||||
```
|
|
||||||
|
|
||||||
Updates to existing packager keys is done using
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./keyringctl import <file_or_directory>
|
|
||||||
```
|
|
||||||
|
44
README.md
44
README.md
@ -18,6 +18,30 @@ from the provided data structure and to install it:
|
|||||||
* python
|
* python
|
||||||
* sequoia-sq
|
* sequoia-sq
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Import of a new packager key
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./keyringctl import <username>.asc
|
||||||
|
# alternatively override the username otherwise derived from the filename
|
||||||
|
./keyringctl import --name <username> <file>
|
||||||
|
```
|
||||||
|
|
||||||
|
Updates to existing packager keys
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# username is automatically derived from the fingerprint
|
||||||
|
./keyringctl import <file_or_directory>
|
||||||
|
```
|
||||||
|
|
||||||
|
Import of a new main key
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# same options as packager key except mandatory --main
|
||||||
|
./keyringctl import --main <username>.asc
|
||||||
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To install archlinux-keyring system-wide use the included `Makefile`:
|
To install archlinux-keyring system-wide use the included `Makefile`:
|
||||||
@ -28,24 +52,8 @@ make install
|
|||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
|
Read our [contributing guide](CONTRIBUTING.md) to learn more about guidelines and
|
||||||
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
|
how to provide fixes or improvements for the code base.
|
||||||
|
|
||||||
Please read our distribution-wide [Code of
|
|
||||||
Conduct](https://terms.archlinux.org/docs/code-of-conduct/) before
|
|
||||||
contributing, to understand what actions will and will not be tolerated.
|
|
||||||
|
|
||||||
Read our [contributing guide](CONTRIBUTING.md) to learn more about how to
|
|
||||||
provide fixes or improvements for the code base and how to add, update or
|
|
||||||
remove key material.
|
|
||||||
|
|
||||||
Discussion around archlinux-keyring may take place on the [arch-projects
|
|
||||||
mailing list](https://lists.archlinux.org/listinfo/arch-projects) and in
|
|
||||||
[#archlinux-projects](ircs://irc.libera.chat/archlinux-projects) on [Libera
|
|
||||||
Chat](https://libera.chat/).
|
|
||||||
|
|
||||||
All past and present authors of archlinux-keyring are listed in
|
|
||||||
[AUTHORS](AUTHORS.md).
|
|
||||||
|
|
||||||
## Releases
|
## Releases
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user