sr: fx2lafw: Add basic support for USBee DX and clones

[libsigrok.git] / README

diff --git a/README b/README
index ae7a55a6ca44338e19350b4cee9c29237b91d80d..e25f227290885a27fc72386f9a3490909ce377c4 100644 (file)
--- a/README
+++ b/README
@@ -11,30 +11,19 @@ for talking to logic analyzer hardware and reading/writing the acquired data
 into various input/output file formats.
 
 
-Status and API
---------------
-
-libsigrok is currently work in progress.
-
-IMPORTANT: The API of libsigrok is NOT yet considered stable! Please do
-           not rely on it, yet! Changes to function names, macro names etc.
-           can happen at any time without prior notice!
-
-
 Requirements
 ------------
 
  - git
- - gcc
+ - gcc (>= 4.0)
  - make
  - autoconf >= 2.63
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
+ - libglib >= 2.28.0
  - libusb >= 1.0.5 (for most logic analyzer hardware)
  - libzip >= 0.8
- - zlib >= 1.2.3.1
  - libftdi >= 0.16 (for some logic analyzer hardware)
  - libudev >= 151 (for some logic analyzer hardware)
 
@@ -62,6 +51,23 @@ Please see the following wiki pages for more detailed instructions:
  http://sigrok.org/wiki/FreeBSD
 
 
+Firmware
+--------
+
+Some devices supported by libsigrok need a firmware to be uploaded before the
+device can be used. 
+
+The default location where libsigrok expects the firmware files is:
+
+  $prefix/share/sigrok-firmware
+
+($prefix is usually /usr/local or /usr, depending on your ./configure options)
+
+For further information see:
+
+  http://sigrok.org/wiki/Firmware
+
+
 Mailing lists
 -------------