From: Gerhard Sittig <redacted>
Date: Sun, 2 Oct 2022 12:14:11 +0000 (+0200)
Subject: README: discuss installation of example captures
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=82263c0bbb90329a952d5580d2fafdbadd9ed304;p=sigrok-dumps.git

README: discuss installation of example captures

The sigrok-dumps repository differs from other components in that it's
neither autotoolized nor uses cmake. Which results in the necessity to
specify non-obvious commands to install the captures without actually
building them.

Introduce an "Installing" README section. Provide example commands for
'make install' invocations.
---

diff --git a/README b/README
index b802721..724a738 100644
--- a/README
+++ b/README
@@ -16,6 +16,23 @@ Status
 sigrok-dumps is in a usable state and has had official tarball releases.
 
 
+Installing
+----------
+
+Example captures need not get built or compiled, but can get installed.
+
+  $ git clone git://sigrok.org/sigrok-dumps
+  $ cd sigrok-dumps
+  $ make install
+
+Optional PREFIX or DESTDIR specs are supported as well.
+
+  $ make PREFIX=/usr install
+  $ make PREFIX=${HOME} install
+
+  $ make DESTDIR=$( pwd )/rootfs install
+
+
 Contributing dumps
 ------------------