Commit graph

12 commits

Author SHA1 Message Date
Florian Schüller
b84e7b8b03 doc/01-usage.md: avoid multiple h1 in one document
Due to https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/Heading_Elements#avoid_using_multiple_h1_elements_on_one_page
metioned in #234 we'll just use a single h1 per document.
2025-06-26 13:06:49 +00:00
Simon de Vlieger
6f883c1407 doc: mention root perms for build
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-09 08:18:20 +00:00
Simon de Vlieger
ea1a42773a doc: document manifest
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-09 08:18:20 +00:00
Simon de Vlieger
1a85fc9248 doc: document describe
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-09 08:18:20 +00:00
Simon de Vlieger
11bf725453 doc: document build --arch
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-09 08:18:20 +00:00
Simon de Vlieger
274a75387b main: rename list-images to list
Rename the `list-images` command to `list`. We don't have `-image(s)` in
our other subcommands so this is for consistency.

We keep a `list-images` alias behind for compatibility reasons.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-08 07:34:20 +00:00
Simon de Vlieger
3eecad6b30 doc: fix typo
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-10 09:28:05 +00:00
Simon de Vlieger
0cc171e1f9 doc: build command
Introduce the `build` command.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-04 09:13:51 +00:00
Simon de Vlieger
ca7ea33765 doc: rename output -> format
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-04 09:13:51 +00:00
Simon de Vlieger
08f8c13c5c doc: list-images
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-04 09:13:51 +00:00
Simon de Vlieger
887d3fee22 doc: sudo for build
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-04 09:13:51 +00:00
Simon de Vlieger
2455b9d586 doc: initial documentation
Supply initial documentation for `image-builder`. This documentation
will be imported into the osbuild [1] website.

[1]: https://osbuild.org/

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-01-31 08:06:22 +00:00