]> sigrok.org Git - libsigrok.git/blobdiff - README
sr: fx2lafw: Forgot to add (C) line to fx2lafw.h in recent commit.
[libsigrok.git] / README
diff --git a/README b/README
index 986973e38073a2e64a5ea005b6d69566cf73e420..33e367a4ced9f1bbd928c058a83c9347ccb82269 100644 (file)
--- a/README
+++ b/README
@@ -11,16 +11,6 @@ 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
 ------------
 
@@ -34,7 +24,6 @@ Requirements
  - libglib >= 2.22.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
 -------------