Pass unitsize to srd_session_send() directly.
[sigrok-cli.git] / README
diff --git a/README b/README
index 00f115567b066970b8f939a555aedb86ead1be0a..0a05ecdfc247f9a37752cd6c3e542b398699e80d 100644 (file)
--- a/README
+++ b/README
@@ -3,8 +3,8 @@ 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).
 
 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,22 +14,22 @@ 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
 ------------
 
- - git
- - gcc
+ - git (only needed when building from git) 
+ - gcc or clang
  - make
- - autoconf >= 2.63
- - automake >= 1.11
- - libtool
+ - autoconf >= 2.63 (only needed when building from git) 
+ - automake >= 1.11 (only needed when building from git) 
+ - libtool (only needed when building from git) 
  - pkg-config >= 0.22
- - libglib >= 2.22.0
- - libsigrok >= 0.2.0
- - libsigrokdecode >= 0.1.0
+ - libglib >= 2.28.0
+ - libsigrok >= 0.4.0
+ - libsigrokdecode >= 0.4.0
 
 
 Building and installing
@@ -37,8 +37,8 @@ Building and installing
 
 In order to get the sigrok-cli source code and build it, run:
 
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/sigrok-cli
+ $ git clone git://sigrok.org/sigrok-cli
+ $ cd sigrok-cli
  $ ./autogen.sh
  $ ./configure
  $ make
@@ -47,21 +47,28 @@ 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
 
 
-Mailing lists
--------------
+Copyright and license
+---------------------
 
-There are two mailing lists for sigrok/sigrok-cli:
+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 list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC
@@ -73,5 +80,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Sigrok-cli