X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=989984ea1f6a2ba558c4a8a08dafae23b2cdf84e;hb=8be8746951e5538147370d9871a4c1ed0268db52;hp=eb8fb11689e6f6e0e85bf01a63586bd47da7a77e;hpb=a5b2293fa84c076236fd3a6c7202ad4996ba16fd;p=libsigrok.git diff --git a/README b/README index eb8fb116..989984ea 100644 --- a/README +++ b/README @@ -4,13 +4,26 @@ README The sigrok project aims at creating a portable, cross-platform, Free/Libre/Open-Source signal analysis software suite that supports various -device types. +device types (such as logic analyzers, oscilloscopes, multimeters, and more). libsigrok is a shared library written in C which provides the basic API for talking to hardware and reading/writing the acquired data into various input/output file formats. +Status +------ + +libsigrok is in a usable state and has had official tarball releases. + +While the API can change from release to release, this will always be +properly documented and reflected in the package version number and +in the shared library / libtool / .so-file version numbers. + +However, there are _NO_ guarantees at all for stable APIs in git snapshots! +Distro packagers should only use released tarballs (no git snapshots). + + Requirements ------------ @@ -22,7 +35,7 @@ Requirements - libtool - pkg-config >= 0.22 - libglib >= 2.28.0 - - libusb >= 1.0.5 (for most hardware) + - libusb >= 1.0.9 (for most hardware) - libzip >= 0.8 - libftdi >= 0.16 (for some hardware) - libudev >= 151 (for some hardware) @@ -86,5 +99,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode. Website ------- -http://sigrok.org + http://sigrok.org/wiki/Libsigrok