README: discuss installation of example captures master
authorGerhard Sittig <gerhard.sittig@gmx.net>
Sun, 2 Oct 2022 12:14:11 +0000 (14:14 +0200)
committerGerhard Sittig <gerhard.sittig@gmx.net>
Sun, 2 Oct 2022 12:32:27 +0000 (14:32 +0200)
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.

README

diff --git a/README b/README
index b802721b45ba4cbe5cec0cbaac861c15052ea83d..724a738163a23317d8ef4524ecbee18cf1baa5ae 100644 (file)
--- 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
 ------------------