prepare all syntax for linters and spellchecks

This commit is contained in:
Florian Schüller 2024-12-20 18:35:10 +01:00 committed by Florian Schüller
parent b932d218e3
commit 734c132500
13 changed files with 84 additions and 91 deletions

View file

@ -1,6 +1,6 @@
# image-builder CLI
Build images from the commandline in a convenient way.
Build images from the command line in a convenient way.
## Run via container
@ -19,7 +19,7 @@ This project is under development right now and needs to be run via:
```console
$ go run github.com/osbuild/image-builder-cli/cmd/image-builder@main
```
or install it into $GOPATH/bin
or install it into `$GOPATH/bin`
```console
$ go install github.com/osbuild/image-builder-cli/cmd/image-builder@main
```
@ -29,7 +29,7 @@ we plan to provide rpm packages as well.
## Prerequisites
Make sure to have the required `osbuild` rpms installed:
Make sure to have the required `osbuild` RPMs installed:
```console
$ sudo dnf install osbuild osbuild-depsolve-dnf osbuild-composer
```
@ -80,7 +80,7 @@ The following filters are currently supported, shell-style globbing is supported
* distro: the distro name (e.g. fedora-41)
* arch: the architecture name (e.g. x86_64)
* type: the image type name (e.g. qcow2)
* bootmode: the bootmode (legacy, uefi, hybrid)
* bootmode: the bootmode (legacy, UEFI, hybrid)
The output can also be switched, supported are "text", "json":
```console
@ -124,7 +124,7 @@ A: The osbuild binary is used to actually build the images but beyond that
* **Website**: <https://www.osbuild.org>
* **Bug Tracker**: <https://github.com/osbuild/image-builder-cli/issues>
* **Discussions**: https://github.com/orgs/osbuild/discussions
* **Discussions**: <https://github.com/orgs/osbuild/discussions>
* **Matrix (chat)**: [Image Builder channel on Fedora Chat](https://matrix.to/#/#image-builder:fedoraproject.org?web-instance[element.io]=chat.fedoraproject.org)
* **Changelog**: <https://github.com/osbuild/image-builder-cli/releases>