Add fx2lafw firmware for FX2 devices with sigrok VID/PID.

[sigrok-firmware-fx2lafw.git] / README

diff --git a/README b/README
index 483b0d47df089da2afbd9d3200bb7d30f45597d3..f937a5c8d5a345211391f9ab4ab235f61662fe71 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,77 @@
-------------------------------------------------------------------------------
-fx2lafw
-------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
+README
+-------------------------------------------------------------------------------
 
-fx2lafw is a free/libre/open-source firmware for logic analyzers based on
-the Cypress EZ-USB FX2(LP) chip.
+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).
 
-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
+------
+
+sigrok-firmware-fx2lafw is in a usable state and has had official
+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, 3.0, 3.1, and 3.2.
+
  - 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.
 
 
-Building
---------
+Building and installing
+-----------------------
 
-  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
-  $ cd fx2lafw
-  $ make
+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
 
-Installation
-------------
+For installing sigrok-firmware-fx2lafw:
 
-  $ sudo make install
+ $ make install
 
 The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
 
 You can override the install location like this:
 
-  $ sudo 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
+
+
+Pre-built firmware files
+------------------------
+
+There are also pre-built firmware files that can be used without having
+to build them from source. You can download those from SourceForge:
+
+  http://sourceforge.net/projects/sigrok/files/binary/sigrok-firmware-fx2lafw/
 
 
 fx2lib
@@ -57,10 +89,36 @@ The following files/directories were removed, as they're not needed
 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
 
 
+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+.
+
+Please see the individual source files for the full list of copyright holders.
+
+
+Mailing list
+------------
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+
+
 Website
 -------
 
-See the fx2lafw website for further information:
-
-  http://sigrok.org/wiki/Fx2lafw
+ http://sigrok.org/wiki/Fx2lafw