output: Add srzip, the session file format.

[libsigrok.git] / README

diff --git a/README b/README
index cb29ccafe6b7c2ee452751a16c52ddb942e28d71..d0d8f1a8b52b0cb434a0c8b80778820b98963776 100644 (file)
--- 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,13 @@ Requirements
  - automake >= 1.11
  - libtool
  - pkg-config >= 0.22
- - libglib >= 2.22.0
- - libusb >= 1.0.5 (for most logic analyzer hardware)
- - libzip >= 0.8
- - zlib >= 1.2.3.1
- - libftdi >= 0.16 (for some logic analyzer hardware)
- - libudev >= 151 (for some logic analyzer hardware)
+ - libglib >= 2.34.0
+ - libzip >= 0.10
+ - libserialport >= 0.1.0 (optional, used by some drivers)
+ - librevisa >= 0.0.20130812 (optional, used by some drivers)
+ - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
+ - libftdi >= 0.16 or libftdi1 >= 1.0 (optional, used by some drivers)
+ - check >= 0.9.4 (optional, only needed to run unit tests)
 
 
 Building and installing
@@ -34,8 +48,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
@@ -44,21 +58,42 @@ For installing libsigrok:
 
  $ 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/Building
+
+
+Device-specific issues
+----------------------
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+Please check README.devices for some notes and hints about device- or
+driver-specific issues to be aware of.
 
 
-Mailing lists
--------------
+Firmware
+--------
 
-There are two mailing lists for sigrok/libsigrok:
+Some devices supported by libsigrok need a firmware to be uploaded before the
+device can be used. See README.devices for details.
+
+
+Copyright and license
+---------------------
+
+libsigrok 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 library 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
@@ -70,5 +105,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 Website
 -------
 
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrok