X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=10e8709683ee019f7553d9830af126e0e07c213a;hb=49c5798c570bb91697bda94fd216722ddfc4995e;hp=d252418471320085079df10ca41f529e08ee5dbf;hpb=eb1a166a24fbe5e2bb2f98e63e0397bf267105f1;p=sigrok-firmware.git

diff --git a/README b/README
index d252418..10e8709 100644
--- a/README
+++ b/README
@@ -2,35 +2,78 @@
 README
 -------------------------------------------------------------------------------
 
-This is a collection of firmware files required for some of the devices
-sigrok supports (logic analyzers, oscilloscopes, or others).
+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.
 
 
-Installation
-------------
+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:
 
-You can install the firmware files like this:
+ $ git clone git://sigrok.org/sigrok-firmware
+ $ cd sigrok-firmware
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+For installing sigrok-firmware:
 
   $ make install
 
-This will install them into /usr/local/share/libsigrok/firmware per default.
+This will install the files into /usr/local/share/sigrok-firmware per default.
 
 You can override the install directory like this:
 
-  $ make DESTDIR=/tmp/foo install
+  $ ./configure --prefix=/usr
+
+See INSTALL or the following wiki page for more (OS-specific) instructions:
+
+ http://sigrok.org/wiki/Building
+
 
+Copyright and license
+---------------------
 
-Licenses
---------
+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.
+
+
+Mailing lists
+-------------
+
+There are two mailing lists for sigrok/sigrok-firmware:
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+ https://lists.sourceforge.net/lists/listinfo/sigrok-commits
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 
 
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Firmware