doc: update IRC reference to Libera.Chat

[sigrok-firmware.git] / README

diff --git a/README b/README
index 049059b67a01b80cf65a2990c9964f17fd6d6bec..d0a5118a79847e4990f66fcc4995faa20d40d09b 100644 (file)
--- a/README
+++ b/README
@@ -2,15 +2,75 @@
 README
 -------------------------------------------------------------------------------
 
-This repository contains a collection of logic analyzer firmware files
-required for some of the logic analyzers sigrok supports.
+The sigrok project aims at creating a portable, cross-platform,
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
+
+sigrok-firmware is a collection of firmware files required for some of the
+devices libsigrok 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.
 
 
+Copyright and license
+---------------------
+
+The 'sigrok-firmware' project/repo/tarball has no license per se, since
+it's just a collection of firmware files from various sources.
+
+Copyright and license info for these firmware files is available here:
+
+ * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
+ * sysclk-lwla/*.rbf: See sysclk-lwla/LICENSE.LWLA.
+
+
+Status
+------
+
+sigrok-firmware is in a usable state and has had official tarball releases.
+
+
+Building and installing
+-----------------------
+
+In order to get the sigrok-firmware source code and build it, run:
+
+ $ git clone git://sigrok.org/sigrok-firmware
+ $ cd sigrok-firmware
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+For installing sigrok-firmware:
+
+  $ make install
+
+This will install the files into /usr/local/share/sigrok-firmware per default.
+
+You can override the install directory like this:
+
+  $ ./configure --prefix=/usr
+
+See INSTALL or the following wiki page for more (OS-specific) instructions:
+
+ http://sigrok.org/wiki/Building
+
+
+Mailing list
+------------
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
+
+
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Firmware