Support sdcc tool names as used on Fedora.

[sigrok-firmware-fx2lafw.git] / README

diff --git a/README b/README
index 2295a7ecb7a5c0a91bdf05ab554745bf14e6e881..f33e7ca72cf62e777ad00df091b248bbf8684743 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,109 @@
-------------------------------------------------------------------------------
-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.x, and 3.x.y.
+
+ - 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
 
-On Debian you can install it via:
+For installing sigrok-firmware-fx2lafw:
 
-  $ apt-get install sdcc
+ $ make install
 
-In order to transfer the firmware onto the FX2 chip, you can use cycfx2prog:
+The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
 
-  $ apt-get install cycfx2prog
+You can override the install location like this:
 
-Building
---------
+ $ ./configure --prefix=/usr
 
-  $ git clone ...
-  $ cd fx2lafw
-  $ git clone git://github.com/mulicheng/fx2lib.git
-  $ make
+Please see the following wiki pages for more detailed instructions:
 
-Usage
------
+ http://sigrok.org/wiki/Linux
+ http://sigrok.org/wiki/Mac_OS_X
+ http://sigrok.org/wiki/Windows
+ http://sigrok.org/wiki/FreeBSD
 
- $ cycfx2prog -id=vvvv:pppp prg:build/fx2lafw.ihx reset run delay:100
 
-You have to provide the USB VID/PID of the FX2 device (before firmware
-upload) using the -id parameter.
+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
 -------
 
-See the fx2lafw website for further information:
-
-  http://sigrok.org/wiki/Fx2lafw
+ http://sigrok.org/wiki/Fx2lafw