diff options
| -rw-r--r-- | README | 78 |
1 files changed, 78 insertions, 0 deletions
@@ -0,0 +1,78 @@ +------------------------------------------------------------------------------- +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. + +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 and API +-------------- + +The libsigrokdecode project is currently work in progress. + +IMPORTANT: The API of libsigrokdecode is NOT yet considered stable! Please do + not rely on it, yet! Changes to function names, macro names etc. + can happen at any time without prior notice! + + The same applies for the API of the Python protocol decoders! + + +Requirements +------------ + + - git + - gcc, g++, make, ... + - autoconf, automake, libtool, pkg-config + - libglib >= 2.22.0 + - Python >= 3.x (for protocol decoders) + + +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 + $ ./autogen.sh + $ ./configure + $ make + +For installing libsigrokdecode: + + $ make install + +Please see the following wiki pages for more detailed instructions: + + http://sigrok.org/wiki/Linux + http://sigrok.org/wiki/Mac_OS_X + http://sigrok.org/wiki/Windows + http://sigrok.org/wiki/FreeBSD + + +Mailing lists +------------- + +There are two mailing lists for sigrok/libsigrokdecode: + + https://lists.sourceforge.net/lists/listinfo/sigrok-devel + https://lists.sourceforge.net/lists/listinfo/sigrok-commits + + +IRC +--- + +You can find the sigrok developers in the #sigrok IRC channel on Freenode. + + +Website +------- + +http://sigrok.org + |