X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=ca3401c1260965278594b01826f852c8045e2f98;hb=8819bf5a960c37561e2bbbffa2685ec477938083;hp=989984ea1f6a2ba558c4a8a08dafae23b2cdf84e;hpb=d11d606626a2ce9359ed2b5395fe4b998604da92;p=libsigrok.git diff --git a/README b/README index 989984ea..ca3401c1 100644 --- a/README +++ b/README @@ -34,11 +34,13 @@ Requirements - automake >= 1.11 - libtool - pkg-config >= 0.22 - - libglib >= 2.28.0 - - libusb >= 1.0.9 (for most hardware) - - libzip >= 0.8 - - libftdi >= 0.16 (for some hardware) - - libudev >= 151 (for some hardware) + - libglib >= 2.32.0 + - libzip >= 0.10 + - 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) + - check >= 0.9.4 (optional, only needed to run unit tests) Building and installing @@ -56,29 +58,36 @@ 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/Linux - http://sigrok.org/wiki/Mac_OS_X - http://sigrok.org/wiki/Windows - http://sigrok.org/wiki/FreeBSD + http://sigrok.org/wiki/Building + + +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