X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=d0d8f1a8b52b0cb434a0c8b80778820b98963776;hb=adfba7368ac297bba20b0afbc7d7322309508b30;hp=f4e8472013ec9ee939b434a77d29c346bf9bc7de;hpb=79bb0e97d53526ef6deb491ea9c7698ed6e90631;p=libsigrok.git diff --git a/README b/README index f4e84720..d0d8f1a8 100644 --- a/README +++ b/README @@ -34,12 +34,12 @@ Requirements - automake >= 1.11 - libtool - 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.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) @@ -58,38 +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/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 -------------- - -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