X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=989984ea1f6a2ba558c4a8a08dafae23b2cdf84e;hb=d55c89f523e74a2f629bb23e8fd9bf6db7e3758a;hp=986973e38073a2e64a5ea005b6d69566cf73e420;hpb=1a081ca67d63a0bd933a3d715792d85afd437296;p=libsigrok.git

diff --git a/README b/README
index 986973e3..989984ea 100644
--- a/README
+++ b/README
@@ -3,22 +3,25 @@ README
 -------------------------------------------------------------------------------
 
 The sigrok project aims at creating a portable, cross-platform,
-Free/Libre/Open-Source logic analyzer software that supports various
-logic analyzer hardware products.
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
 
 libsigrok is a shared library written in C which provides the basic API
-for talking to logic analyzer hardware and reading/writing the acquired data
-into various input/output file formats.
+for talking to hardware and reading/writing the acquired data into various
+input/output file formats.
 
 
-Status and API
---------------
+Status
+------
 
-libsigrok is currently work in progress.
+libsigrok is in a usable state and has had official tarball releases.
 
-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!
+While the API can change from release to release, this will always be
+properly documented and reflected in the package version number and
+in the shared library / libtool / .so-file version numbers.
+
+However, there are _NO_ guarantees at all for stable APIs in git snapshots!
+Distro packagers should only use released tarballs (no git snapshots).
 
 
 Requirements
@@ -31,12 +34,11 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
- - libusb >= 1.0.5 (for most logic analyzer hardware)
+ - libglib >= 2.28.0
+ - libusb >= 1.0.9 (for most hardware)
  - libzip >= 0.8
- - zlib >= 1.2.3.1
- - libftdi >= 0.16 (for some logic analyzer hardware)
- - libudev >= 151 (for some logic analyzer hardware)
+ - libftdi >= 0.16 (for some hardware)
+ - libudev >= 151 (for some hardware)
 
 
 Building and installing
@@ -44,8 +46,8 @@ Building and installing
 
 In order to get the libsigrok source code and build it, run:
 
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/libsigrok
+ $ git clone git://sigrok.org/libsigrok
+ $ cd libsigrok
  $ ./autogen.sh
  $ ./configure
  $ make
@@ -62,6 +64,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
 -------------
 
@@ -80,5 +99,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrok