From c2d7afa2dd9499cb3271c4a5afd6230fbc8dadf0 Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Mar 04 2022 15:50:37 +0000 Subject: [PATCH 1/3] README: install instructions Instruct users how to install from distribution packages or a Git clone. --- diff --git a/README.rst b/README.rst index 366216a..2379d7c 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,20 @@ Compose Utils A set of utilities for working with composes. +Install it in Fedora or EPEL:: + + yum -y install compose-utils + +Or run directly from Git in a virtualenv:: + + git clone https://pagure.io/compose-utils.git + cd compose-utils + python3 -m venv venv + . venv/bin/activate + python setup.py develop + + # The commands will be in your $PATH, for example: + compose-diff-rpms ... Contents -------- From 22a3f307b3edb295fca5b73af833b68759e46dd2 Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Mar 04 2022 15:50:55 +0000 Subject: [PATCH 2/3] README: explain "composes" in top-level description This helps new users understand what a "compose" is. --- diff --git a/README.rst b/README.rst index 2379d7c..bea4fba 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,9 @@ Compose Utils ============= -A set of utilities for working with composes. +A set of utilities for working with `Pungi composes +`_. Composes are release snapshots that contain a set +of builds. Install it in Fedora or EPEL:: From 538b59452fda97640a9058d2e5b874aecdf523dd Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Mar 04 2022 15:51:46 +0000 Subject: [PATCH 3/3] README: update reference to compose-changelog "the changelog" is ambiguous. Update this reference to the compose-changelog tool. --- diff --git a/README.rst b/README.rst index bea4fba..9d851d6 100644 --- a/README.rst +++ b/README.rst @@ -31,7 +31,7 @@ Contents **compose-diff-rpms** generate a difference in packages between two composes. This is a bit more - low-level than the changelog. + low-level than ``compose-changelog``. **compose-dump-listings** write listing of packages in a compose useful for tracking disappearing