From 2bc0088767471f28ebc7cf9473ccd798daeb615c Mon Sep 17 00:00:00 2001 From: Javier Martinez Canillas Date: Tue, 13 Jul 2021 11:46:36 +0200 Subject: [PATCH] README: improve Build section The current Build section is misleading, since running the commands that are mentioned there will lead to only the osbuild module and osbuild-mpp tool to be installed. But none of the other required artifacts (sources, stages, schemas, etc) will, causing the installed osbuild to not work at all. Instead, have an Install section that explains how osbuild can be installed from RPMs. --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 663d44ad..fccb8037 100644 --- a/README.md +++ b/README.md @@ -43,21 +43,26 @@ Testing requires additional software: * `pytest` -### Build +### Install -The standard python package system is used. Consult upstream documentation for -detailed help. In most situations the following commands are sufficient to -build and install from source: +Installing `osbuild` requires to not only install the `osbuild` module, but also +additional artifacts such as tools (i.e: `osbuild-mpp`) sources, stages, schemas +and SELinux policies. + +For this reason, doing an installation from source is not trivial and the easier +way to install it is to create the set of RPMs that contain all these components. + +This can be done with the `rpm` make target, i.e: ```sh -python setup.py build -python setup.py install --skip-build --root=/ +make rpm ``` -The man-pages require `python-docutils` and can be built via: +A set of RPMs will be created in the `./rpmbuild/RPMS/noarch/` directory and can +be installed in the system using the distribution package manager, i.e: ```sh -rst2man docs/.rst +sudo dnf install ./rpmbuild/RPMS/noarch/*.rpm ``` ### Repository: