hantek_6022be.c: Fix build error.

[sigrok-firmware-fx2lafw.git] / README

diff --git a/README b/README
index bd7fbfcf4fadf23aed551f9779fe7d410f1dc589..7c1e6e758d601af4faa3462c649731c8bbb0d656 100644 (file)
--- a/README
+++ b/README
@@ -6,12 +6,8 @@ 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).
 
-fx2lafw is a Free/Libre/Open-source firmware for logic analyzers based on
-the Cypress EZ-USB FX2(LP) chip.
-
-It is licensed under the terms of the GNU GPL (version 2 or later), and uses
-additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
-or later).
+sigrok-firmware-fx2lafw is a Free/Libre/Open-source firmware for logic
+analyzers based on the Cypress EZ-USB FX2(LP) chip.
 
 
 Status
@@ -24,11 +20,21 @@ tarball releases.
 Requirements
 ------------
 
- - In order to build fx2lafw you need the 'sdcc' compiler.
+ - git
+ - make
+ - autoconf >= 2.63
+ - automake >= 1.11
+ - sdcc (>= 2.9.0)
+
+Notes:
+
+ - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
    On Debian you can install it via:
 
      $ apt-get install sdcc
 
+   This project has been tested to work with sdcc 2.9 and 3.x.
+
  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
    versions didn't have support for FX2 devices using this firmware.
 
@@ -40,6 +46,8 @@ In order to get the sigrok-firmware-fx2lafw source code and build it, run:
 
  $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
  $ cd sigrok-firmware-fx2lafw
+ $ ./autogen.sh
+ $ ./configure
  $ make
 
 For installing sigrok-firmware-fx2lafw:
@@ -50,14 +58,20 @@ The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
 
 You can override the install location like this:
 
- $ make install DESTDIR=/usr/share/sigrok-firmware
+ $ ./configure --prefix=/usr
+
+See INSTALL or the following wiki page for more (OS-specific) instructions:
+
+ http://sigrok.org/wiki/Building
+
 
-Please see the following wiki pages for more detailed instructions:
+Pre-built firmware files
+------------------------
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+There are also pre-built firmware files that can be used without having
+to build them from source. You can download those from:
+
+  http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/
 
 
 fx2lib
@@ -75,13 +89,26 @@ The following files/directories were removed, as they're not needed
 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
 
 
-Mailing lists
--------------
+Copyright and license
+---------------------
+
+sigrok-firmware-fx2lafw is licensed under the terms of the GNU General Public
+License (GPL), version 2 or later.
+
+It uses additional helper code (fx2lib), licensed under the GNU LGPL
+(version 2.1 or later).
+
+While some individual source code files are licensed under the LGPLv2.1+, and
+some files are licensed under the GPLv2+, this doesn't change the fact that
+the firmware as a whole is licensed under the terms of the GPLv2+.
 
-There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
+Please see the individual source files for the full list of copyright holders.
+
+
+Mailing list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC