-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

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).


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 (>= 2.8.0).
   On Debian you can install it via:

     $ apt-get install sdcc

   This project has been tested to work with sdcc 2.8, 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.


Building and installing
-----------------------

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:

 $ make install

The generated *.fw files are installed into /usr/local/share/sigrok-firmware.

You can override the install location like this:

 $ ./configure --prefix=/usr

Please see the following wiki pages for more detailed instructions:

 http://sigrok.org/wiki/Linux
 http://sigrok.org/wiki/Mac_OS_X
 http://sigrok.org/wiki/Windows
 http://sigrok.org/wiki/FreeBSD


fx2lib
------

The fx2lafw code uses a (slightly modified) "fx2lib" helper library.

It was imported into fx2lafw from

  git://github.com/ubixum/fx2lib.git

as of Feb 12, 2012 (git hash "416c104cbd").

The following files/directories were removed, as they're not needed
for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.


Mailing lists
-------------

There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:

 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/wiki/Fx2lafw