X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=README;h=989984ea1f6a2ba558c4a8a08dafae23b2cdf84e;hp=33e367a4ced9f1bbd928c058a83c9347ccb82269;hb=d11d606626a2ce9359ed2b5395fe4b998604da92;hpb=f9a33a4720403e7db4d69cb698b18dd724e16db7 diff --git a/README b/README index 33e367a4..989984ea 100644 --- a/README +++ b/README @@ -3,12 +3,25 @@ README ------------------------------------------------------------------------------- The sigrok project aims at creating a portable, cross-platform, -Free/Libre/Open-Source logic analyzer software that supports various -logic analyzer hardware products. +Free/Libre/Open-Source signal analysis software suite that supports various +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 logic analyzer hardware and reading/writing the acquired data -into various input/output file formats. +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 @@ -21,11 +34,11 @@ Requirements - automake >= 1.11 - libtool - pkg-config >= 0.22 - - libglib >= 2.22.0 - - libusb >= 1.0.5 (for most logic analyzer hardware) + - libglib >= 2.28.0 + - libusb >= 1.0.9 (for most hardware) - libzip >= 0.8 - - libftdi >= 0.16 (for some logic analyzer hardware) - - libudev >= 151 (for some logic analyzer hardware) + - libftdi >= 0.16 (for some hardware) + - libudev >= 151 (for some hardware) Building and installing @@ -33,8 +46,8 @@ Building and installing In order to get the libsigrok source code and build it, run: - $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok - $ cd sigrok/libsigrok + $ git clone git://sigrok.org/libsigrok + $ cd libsigrok $ ./autogen.sh $ ./configure $ make @@ -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