]> sigrok.org Git - sigrok-firmware-fx2lafw.git/blobdiff - README
Makefile: Add a 'distbin' target.
[sigrok-firmware-fx2lafw.git] / README
diff --git a/README b/README
index fd9dc2531f7d7585cfa65f197614d37aad5c9121..483b0d47df089da2afbd9d3200bb7d30f45597d3 100644 (file)
--- a/README
+++ b/README
@@ -5,17 +5,21 @@ 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.
+ - In order to build fx2lafw you need the 'sdcc' compiler.
+   On Debian you can install it via:
 
-On Debian you can install it via:
+     $ apt-get install sdcc
 
-  $ apt-get install sdcc
+ - 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
@@ -26,24 +30,32 @@ Building
   $ make
 
 
-Usage
------
+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
+------
 
-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).
+The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
 
-Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
+It was imported into fx2lafw from
 
-Example (assuming /usr/local as $prefix):
+  git://github.com/ubixum/fx2lib.git
 
-  $ sudo mkdir /usr/local/share/sigrok-firmware
+as of Feb 12, 2012 (git hash "416c104cbd").
 
-  $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
-            /usr/local/share/sigrok-firmware
+The following files/directories were removed, as they're not needed
+for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
 
-The sigrok frontends (command-line or GUI) will automatically search for
-firmware files there and automatically use/upload them.
-  
 
 Website
 -------