X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=README;h=768c8ca2b6612d1850d69f8f25e95c830850aef7;hp=f4e8472013ec9ee939b434a77d29c346bf9bc7de;hb=HEAD;hpb=79bb0e97d53526ef6deb491ea9c7698ed6e90631 diff --git a/README b/README index f4e84720..8686a262 100644 --- a/README +++ b/README @@ -27,20 +27,71 @@ 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.28.0 - - libzip >= 0.8 - - libusb-1.0 >= 1.0.9 (optional, used by most drivers) - - libftdi >= 0.16 (optional, used by some drivers) - - libudev >= 151 (optional, used by some drivers) - - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver) + - libglib >= 2.32.0 + - zlib (optional, used for CRC32 calculation in STF input) + - 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) + - 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.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) or glibmm-2.68 (>= 2.68.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 @@ -58,44 +109,52 @@ 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 + +Please also check the following wiki page in case you encounter any issues: + + http://sigrok.org/wiki/Building#FAQ - http://sigrok.org/wiki/Linux - http://sigrok.org/wiki/Mac_OS_X - http://sigrok.org/wiki/Windows - http://sigrok.org/wiki/FreeBSD + +Device-specific issues +---------------------- + +Please check README.devices for some notes and hints about device- or +driver-specific issues to be aware of. Firmware -------- Some devices supported by libsigrok need a firmware to be uploaded before the -device can be used. +device can be used. See README.devices for details. -The default location where libsigrok expects the firmware files is: - $prefix/share/sigrok-firmware +Copyright and license +--------------------- -($prefix is usually /usr/local or /usr, depending on your ./configure options) +libsigrok is licensed under the terms of the GNU General Public License +(GPL), version 3 or later. -For further information see: +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+. - http://sigrok.org/wiki/Firmware +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