Use the new libsigrokdecode session API
[sigrok-cli.git] / README
diff --git a/README b/README
index 612211d1f55f6327b2ad18125227a4965e8583b8..535538289008f48b503606783d7ee90715fad894 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ README
 
 The sigrok project aims at creating a portable, cross-platform,
 Free/Libre/Open-Source signal analysis software suite that supports various
-device types.
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
 
 sigrok-cli is a command-line tool written in C, which uses both libsigrok
 and libsigrokdecode to provide the basic sigrok functionality from the
@@ -14,7 +14,7 @@ command-line. Among other things, it's useful for scripting purposes.
 Status
 ------
 
-The sigrok-cli project, while still in development, is pretty stable/usable.
+sigrok-cli is in a usable state and has had official tarball releases.
 
 
 Requirements
@@ -29,7 +29,7 @@ Requirements
  - pkg-config >= 0.22
  - libglib >= 2.28.0
  - libsigrok >= 0.2.0
- - libsigrokdecode >= 0.1.0
+ - libsigrokdecode >= 0.2.0
 
 
 Building and installing
@@ -47,12 +47,22 @@ For installing sigrok-cli:
 
  $ make install
 
-Please see the following wiki pages for more detailed instructions:
+See INSTALL or the following wiki page for more (OS-specific) instructions:
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+ http://sigrok.org/wiki/Building
+
+
+Copyright and license
+---------------------
+
+sigrok-cli is licensed under the terms of the GNU General Public License
+(GPL), version 3 or later.
+
+While some individual source code files are licensed under the GPLv2+, and
+some files are licensed under the GPLv3+, this doesn't change the fact that
+the program as a whole is licensed under the terms of the GPLv3+.
+
+Please see the individual source files for the full list of copyright holders.
 
 
 Mailing lists
@@ -73,5 +83,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Sigrok-cli