]> sigrok.org Git - sigrok-firmware.git/commitdiff
README: Small updates, document 'make install'.
authorUwe Hermann <redacted>
Wed, 23 May 2012 16:40:26 +0000 (18:40 +0200)
committerUwe Hermann <redacted>
Thu, 24 May 2012 08:57:39 +0000 (10:57 +0200)
README

diff --git a/README b/README
index 049059b67a01b80cf65a2990c9964f17fd6d6bec..d252418471320085079df10ca41f529e08ee5dbf 100644 (file)
--- a/README
+++ b/README
@@ -2,13 +2,33 @@
 README
 -------------------------------------------------------------------------------
 
-This repository contains a collection of logic analyzer firmware files
-required for some of the logic analyzers sigrok supports.
+This is a collection of firmware files required for some of the devices
+sigrok supports (logic analyzers, oscilloscopes, or others).
 
 We only carry firmware files for which we have an explicit permission/license
 that allows at _least_ redistribution of the firmware.
 
 
+Installation
+------------
+
+You can install the firmware files like this:
+
+  $ make install
+
+This will install them into /usr/local/share/libsigrok/firmware per default.
+
+You can override the install directory like this:
+
+  $ make DESTDIR=/tmp/foo install
+
+
+Licenses
+--------
+
+ * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
+
+
 Website
 -------