]> sigrok.org Git - sigrok-firmware-fx2lafw.git/blobdiff - README
Makefile: Add an 'install' target.
[sigrok-firmware-fx2lafw.git] / README
diff --git a/README b/README
index 2295a7ecb7a5c0a91bdf05ab554745bf14e6e881..a724b02d7c6cc2db361890e749a294406daff59f 100644 (file)
--- a/README
+++ b/README
@@ -5,36 +5,48 @@ 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 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 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
+Copy the generated *.fw file for your device (e.g. fx2lafw-saleae-logic.fw)
+into the $prefix/share/sigrok-firmware directory (create it, if needed).
+
+Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
+
+Example (assuming /usr/local as $prefix):
+
+  $ sudo mkdir /usr/local/share/sigrok-firmware
+
+  $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
+            /usr/local/share/sigrok-firmware
 
-You have to provide the USB VID/PID of the FX2 device (before firmware
-upload) using the -id parameter.
+The sigrok frontends (command-line or GUI) will automatically search for
+firmware files there and automatically use/upload them.
+  
 
 Website
 -------