diff options
| author | Uwe Hermann <uwe@hermann-uwe.de> | 2012-10-10 23:37:19 +0200 |
|---|---|---|
| committer | Uwe Hermann <uwe@hermann-uwe.de> | 2012-10-10 23:39:18 +0200 |
| commit | d3b034e68fe544f823d66ead4c1561a33c9f135d (patch) | |
| tree | c771166c7f8ad34bb2ae7bcff97cece724dd9377 | |
| parent | b08272363131621c7571a02ac752e727e0ed54df (diff) | |
| download | libsigrokdecode-d3b034e68fe544f823d66ead4c1561a33c9f135d.tar.gz libsigrokdecode-d3b034e68fe544f823d66ead4c1561a33c9f135d.zip | |
README: Add status, update URL, small fixes.
| -rw-r--r-- | README | 19 |
1 files changed, 16 insertions, 3 deletions
@@ -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 ------------ @@ -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 |