Skip to content

Commit

Permalink
README.md: add more details about the build dependencies
Browse files Browse the repository at this point in the history
also add a general description.
  • Loading branch information
schuellerf committed Oct 17, 2024
1 parent a1dccd8 commit 7b89d25
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
6 changes: 6 additions & 0 deletions .spellcheck-en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,9 @@ cmds
depsolving
subcommand
teardown
Koji
bootc
btrfs
devicemapper
graphdriver
subpackages
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Images
======

This repository is, primarily, a Go library for generating osbuild manifests
([more details here](./docs/developer/code-manifest-generation.md)).
It also has some libraries for uploading artifacts to cloud platforms and Koji.
The binaries implemented in `cmd/` are for development and testing purposes and not part of the library.

## Project

* **Website**: <https://www.osbuild.org>
Expand All @@ -21,18 +26,26 @@ Please refer to the [developer guide](https://www.osbuild.org/docs/developer-gui

See also the [local developer documentation](./docs/developer) for useful information about working with this specific project.

The build-requirements for Fedora and rpm-based distributions are:
- `btrfs-progs-devel`
- `device-mapper-devel`
- `gcc`
- `git-core`
The build-requirements of the Go library for Fedora and rpm-based distributions are:

- `go`
- `gpgme-devel`
- `krb5-devel`
- `osbuild-depsolve-dnf`

(see also [`Containerfile`](Containerfile) )

Other dependencies only needed in some cases are:

- `btrfs-progs-devel`, `device-mapper-devel`
build dependencies for the unit tests and projects that import `pkg/container`, which even in that case can be skipped using exclude_graphdriver_btrfs and exclude_graphdriver_devicemapper (see bootc-image-builder).
- `krb5-devel`
build dependency for the unit tests and projects that import `pkg/upload/koji`
- `osbuild-depsolve-dnf`
runtime dependency for the unit tests and projects that import `pkg/dnfjson`.
or to run `cmd/gen-manifests` and `cmd/build`
- `osbuild` (and subpackages)
runtime dependencies for `cmd/build`.


### Repository:

- **web**: <https://github.com/osbuild/images>
Expand Down

0 comments on commit 7b89d25

Please sign in to comment.