X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=README;h=989984ea1f6a2ba558c4a8a08dafae23b2cdf84e;hb=a97a3d708930a62bbc296785664b0d2677b233b2;hp=cb29ccafe6b7c2ee452751a16c52ddb942e28d71;hpb=8a6b5b50e1555744374781f0a438c8965f501e98;p=libsigrok.git

diff --git a/README b/README
index cb29ccaf..989984ea 100644
--- a/README
+++ b/README
@@ -3,12 +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
+------
+
+libsigrok is in a usable state and has had official tarball releases.
+
+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
@@ -21,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
@@ -34,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
@@ -52,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
 -------------
 
@@ -70,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