Import fx2lib into fx2lafw directly.

[sigrok-firmware-fx2lafw.git] / README

diff --git a/README b/README
index 843190eb414b6e1c4c7c6a04df9c6ee2bbf1cbbf..fd9dc2531f7d7585cfa65f197614d37aad5c9121 100644 (file)
--- a/README
+++ b/README
@@ -7,6 +7,7 @@ the Cypress EZ-USB FX2(LP) chip.
 
 It is licensed under the terms of the GNU GPL (version 2 or later).
 
+
 Requirements
 ------------
 
@@ -16,25 +17,33 @@ On Debian you can install it via:
 
   $ apt-get install sdcc
 
-In order to transfer the firmware onto the FX2 chip, you can use cycfx2prog:
-
-  $ 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
+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
 -------