X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=7a5e7feeb4eaaddc8bd7fdcc3069524308c94c81;hb=fc6f8a337f2d4ab3a1c31a1a5a45e03aa0b53f6f;hp=026f56bd8223c2a6d1145bb2089383da3e7d86c9;hpb=91f1e17f79efcd2cea5e3d43efe4b339a664d830;p=sigrok-firmware-fx2lafw.git

diff --git a/README b/README
index 026f56bd..7a5e7fee 100644
--- a/README
+++ b/README
@@ -1,48 +1,115 @@
-------------------------------------------------------------------------------
-fx2lafw
-------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
+README
+-------------------------------------------------------------------------------
 
-fx2lafw is a free/libre/open-source firmware for logic analyzers based on
+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).
+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.
+ - 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 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
 
-On Debian you can install it via:
+The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
 
-  $ apt-get install sdcc
+You can override the install location like this:
 
-In order to transfer the firmware onto the FX2 chip, you can use cycfx2prog:
+ $ ./configure --prefix=/usr
 
-  $ apt-get install cycfx2prog
+See INSTALL or the following wiki page for more (OS-specific) instructions:
 
-Building
---------
+ http://sigrok.org/wiki/Building
 
-  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
-  $ cd fx2lafw
-  $ git clone git://github.com/mulicheng/fx2lib.git
-  $ make
 
-Usage
------
+Pre-built firmware files
+------------------------
 
- $ cycfx2prog -id=vvvv:pppp prg:<device>.ihx reset run delay:100
+There are also pre-built firmware files that can be used without having
+to build them from source. You can download those from SourceForge:
 
-You have to provide the USB VID/PID of the FX2 device (before firmware
-upload) using the -id parameter.
+  http://sourceforge.net/projects/sigrok/files/binary/sigrok-firmware-fx2lafw/
+
+
+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.
 
-Replace <device>.ihx with the respective .ihx file from the
-hw/*/build/ directory, e.g. hw/saleae-logic/build/fx2lafw-saleae-logic.ihx.
 
 Website
 -------
 
-See the fx2lafw website for further information:
-
-  http://sigrok.org/wiki/Fx2lafw
+ http://sigrok.org/wiki/Fx2lafw