X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=483b0d47df089da2afbd9d3200bb7d30f45597d3;hb=d319a25de291b75b6bb76463bdc1aa1c851182d8;hp=843190eb414b6e1c4c7c6a04df9c6ee2bbf1cbbf;hpb=060dc3fe95b5e167c3c09ba0e8bc164c2ec25d69;p=sigrok-firmware-fx2lafw.git

diff --git a/README b/README
index 843190eb..483b0d47 100644
--- a/README
+++ b/README
@@ -5,36 +5,57 @@ fx2lafw
 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).
+
 
 Requirements
 ------------
 
-In order to build fx2lafw you need the 'sdcc' compiler.
-
-On Debian you can install it via:
+ - In order to build fx2lafw you need the 'sdcc' compiler.
+   On Debian you can install it via:
 
-  $ apt-get install sdcc
+     $ apt-get install sdcc
 
-In order to transfer the firmware onto the FX2 chip, you can use cycfx2prog:
+ - 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.
 
-  $ apt-get install cycfx2prog
 
 Building
 --------
 
   $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
   $ cd fx2lafw
-  $ git clone git://github.com/mulicheng/fx2lib.git
   $ make
 
-Usage
------
 
- $ cycfx2prog -id=vvvv:pppp prg:build/fx2lafw.ihx reset run delay:100
+Installation
+------------
+
+  $ sudo 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
+
+
+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/.
 
-You have to provide the USB VID/PID of the FX2 device (before firmware
-upload) using the -id parameter.
 
 Website
 -------