X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=README;h=768c8ca2b6612d1850d69f8f25e95c830850aef7;hp=7ca82056c209e2e2ce4075ad392f9f84a99ade00;hb=HEAD;hpb=e26f5af3593b6d826a8ad7bed399935197454f2c diff --git a/README b/README index 7ca82056..8686a262 100644 --- a/README +++ b/README @@ -36,32 +36,39 @@ Requirements for the C library: - automake >= 1.11 (only needed when building from git) - libtool (only needed when building from git) - pkg-config >= 0.22 - - libglib >= 2.34.0 + - libglib >= 2.32.0 + - zlib (optional, used for CRC32 calculation in STF input) - libzip >= 0.10 - - libserialport >= 0.1.0 (optional, used by some drivers) - - librevisa >= 0.0.20130812 (optional, used by some drivers) + - 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) - - libftdi >= 0.16 or libftdi1 >= 1.0 (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) + - nettle (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.3.0 (the libsigrok C library, see above) + - 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.7) - - clang++ (>= 3.1) + - 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) + - glibmm-2.4 (>= 2.32.0) or glibmm-2.68 (>= 2.68.0) Requirements for the Python bindings: - - libsigrokxx >= 0.3.0 (the libsigrok C++ bindings, see above) + - 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 @@ -71,9 +78,16 @@ Requirements for the Python bindings: - 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: - - libsigrokxx >= 0.3.0 (the libsigrok C++ bindings, see above) + - 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) @@ -99,6 +113,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 ---------------------- @@ -136,7 +154,7 @@ Mailing list 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