kingst-la2016: fix segfault that often occurs when a capture is aborted

[libsigrok.git] / README

diff --git a/README b/README
index 831b3106d6295f32b1c511abcad48eb3e7e441ca..d1f965667bc828ffd60d64fbbb0d07129d0fa49f 100644 (file)
--- a/README
+++ b/README
@@ -27,19 +27,69 @@ Distro packagers should only use released tarballs (no git snapshots).
 Requirements
 ------------
 
- - git
- - gcc (>= 4.0)
+Requirements for the C library:
+
+ - git (only needed when building from git)
+ - gcc (>= 4.0) 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.32.0
- - libzip >= 0.8
- - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
- - libftdi >= 0.16 (optional, used by some drivers)
- - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
+ - libzip >= 0.10
+ - libtirpc (optional, used by VXI, fallback when glibc >= 2.26)
+ - libserialport >= 0.1.1 (optional, used by some drivers)
+ - librevisa >= 0.0.20130412 (optional, used by some drivers)
+ - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
+ - hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
+ - bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication)
+ - libftdi1 >= 1.0 (optional, used by some drivers)
+ - libgpib (optional, used by some drivers)
+ - libieee1284 (optional, used by some drivers)
+ - libgio >= 2.32.0 (optional, used by some drivers)
  - check >= 0.9.4 (optional, only needed to run unit tests)
+ - doxygen (optional, only needed for the C API docs)
+ - graphviz (optional, only needed for the C API docs)
+
+Requirements for the C++ bindings:
+
+ - libsigrok >= 0.4.0 (the libsigrok C library, see above)
+ - A C++ compiler with C++11 support (-std=c++11 option), e.g.
+   - g++ (>= 4.8.1)
+   - clang++ (>= 3.3)
+ - autoconf-archive (only needed when building from git)
+ - doxygen (required for building the bindings, not only for C++ API docs!)
+ - graphviz (optional, only needed for the C++ API docs)
+ - Python (2 or 3) executable (development files are not needed)
+ - glibmm-2.4 (>= 2.32.0)
+
+Requirements for the Python bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - Python >= 2.7 or Python >= 3 (including development files!)
+ - Python setuptools (for Python 2 or 3)
+ - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
+ - numpy (for Python 2 or 3)
+ - SWIG >= 2.0.0
+ - doxygen (optional, only needed for the Python API docs)
+ - graphviz (optional, only needed for the Python API docs)
+ - doxypy (optional, only needed for the Python API docs)
+
+Requirements for the Ruby bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - Ruby >= 2.5.0 (including development files!)
+ - SWIG >= 3.0.8
+ - YARD (optional, only needed for the Ruby API docs)
+
+Requirements for the Java bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - SWIG >= 2.0.0
+ - Java JDK (for JNI includes and the javac/jar binaries)
+ - doxygen (optional, only needed for the Java API docs)
+ - graphviz (optional, only needed for the Java API docs)
 
 
 Building and installing
@@ -61,6 +111,10 @@ See INSTALL or the following wiki page for more (OS-specific) instructions:
 
  http://sigrok.org/wiki/Building
 
+Please also check the following wiki page in case you encounter any issues:
+
+ http://sigrok.org/wiki/Building#FAQ
+
 
 Device-specific issues
 ----------------------
@@ -89,19 +143,16 @@ 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 lists
--------------
-
-There are two mailing lists for sigrok/libsigrok:
+Mailing list
+------------
 
  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 
 
 IRC
 ---
 
-You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
 
 
 Website