X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=README;h=ee34529094842e52b3399903393ef007d7214ab5;hp=a61a4a6e1e45344a41293e352849efec02ece176;hb=e0af499b4f5840190807636e536e1fb4956f71a9;hpb=387b6e3bb4340e20c978a8c47037d0bea9cca3c0 diff --git a/README b/README index a61a4a6..ee34529 100644 --- a/README +++ b/README @@ -3,14 +3,27 @@ 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). libsigrokdecode is a shared library written in C which provides the basic API for running sigrok protocol decoders. The protocol decoders themselves are written in Python. +Status +------ + +libsigrokdecode 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 ------------ @@ -30,8 +43,8 @@ Building and installing In order to get the libsigrokdecode source code and build it, run: - $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok - $ cd sigrok/libsigrokdecode + $ git clone git://sigrok.org/libsigrokdecode + $ cd libsigrokdecode $ ./autogen.sh $ ./configure $ make @@ -66,5 +79,5 @@ You can find the sigrok developers in the #sigrok IRC channel on Freenode. Website ------- -http://sigrok.org + http://sigrok.org/wiki/Libsigrokdecode