README

The sigrok project aims at creating a portable, cross-platform, Free/Libre/Open-Source logic analyzer software that supports various (usually USB-based) logic analyzer hardware products.

There are two shared libraries with common code, a command line utility for basic usage and easy scriptability, as well as an intuitive GUI.

Status and API

The sigrok project is currently work in progress.

IMPORTANT: The API of the libraries 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!

Requirements

• git
• gcc, g++, make, ...
• autoconf, automake, libtool, pkg-config
• libglib >= 2.0
• libusb >= 1.0.5 (for most logic analyzer hardware)
• libzip >= 0.8
• libftdi >= 0.16 (for some logic analyzer hardware)
• libudev >= 151 (for some logic analyzer hardware)
• Python >= 2.5 (for protocol decoders)
• Qt + Qt Creator >= 4.5 (for building/editing the GUI)

Building and installing

In order to get the sigrok source code and build it, run:

$ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok $ cd sigrok $ ./autogen.sh $ ./configure $ make

For building the GUI:

$ cd gui $ qmake $ make

NOTE: The GUI is not yet usable, it's work-in-progress!

For installing sigrok:

$ 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

Mailing lists

There are two mailing lists for sigrok:

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