README: Add status, update URL, small fixes.
authorUwe Hermann <uwe@hermann-uwe.de>
Wed, 10 Oct 2012 21:37:19 +0000 (23:37 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Wed, 10 Oct 2012 21:39:18 +0000 (23:39 +0200)
README

diff --git a/README b/README
index a61a4a6e1e45344a41293e352849efec02ece176..820fccc5077a5c208f65723e110714ef6305f025 100644 (file)
--- a/README
+++ b/README
@@ -3,14 +3,27 @@ README
 -------------------------------------------------------------------------------
 
 The sigrok project aims at creating a portable, cross-platform,
 -------------------------------------------------------------------------------
 
 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).
 
 libsigrokdecode is a shared library written in C which provides the basic
 API for running sigrok protocol decoders. The protocol decoders themselves
 are written in Python.
 
 
 
 libsigrokdecode is a shared library written in C which provides the basic
 API for running sigrok protocol decoders. The protocol decoders themselves
 are written in Python.
 
 
+Status
+------
+
+libsigrokdecode 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
 ------------
 
 Requirements
 ------------
 
@@ -66,5 +79,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrokdecode