README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 The sigrok project aims at creating a portable, cross-platform,
   6 Free/Libre/Open-Source logic analyzer software that supports various
   7 logic analyzer hardware products.
   8
   9 libsigrokdecode is a shared library written in C which provides the basic
  10 API for running sigrok protocol decoders. The protocol decoders themselves
  11 are written in Python.
  12
  13
  14 Status and API
  15 --------------
  16
  17 The libsigrokdecode project is currently work in progress.
  18
  19 IMPORTANT: The API of libsigrokdecode is NOT yet considered stable! Please do
  20            not rely on it, yet! Changes to function names, macro names etc.
  21            can happen at any time without prior notice!
  22
  23            The same applies for the API of the Python protocol decoders!
  24
  25
  26 Requirements
  27 ------------
  28
  29  - git
  30  - gcc
  31  - make
  32  - autoconf >= 2.63
  33  - automake >= 1.11
  34  - libtool
  35  - pkg-config >= 0.22
  36  - libglib >= 2.22.0
  37  - Python >= 3.x (for protocol decoders)
  38
  39
  40 Building and installing
  41 -----------------------
  42
  43 In order to get the libsigrokdecode source code and build it, run:
  44
  45  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
  46  $ cd sigrok/libsigrokdecode
  47  $ ./autogen.sh
  48  $ ./configure
  49  $ make
  50
  51 For installing libsigrokdecode:
  52
  53  $ make install
  54
  55 Please see the following wiki pages for more detailed instructions:
  56
  57  http://sigrok.org/wiki/Linux
  58  http://sigrok.org/wiki/Mac_OS_X
  59  http://sigrok.org/wiki/Windows
  60  http://sigrok.org/wiki/FreeBSD
  61
  62
  63 Mailing lists
  64 -------------
  65
  66 There are two mailing lists for sigrok/libsigrokdecode:
  67
  68  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  69  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  70
  71
  72 IRC
  73 ---
  74
  75 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  76
  77
  78 Website
  79 -------
  80
  81 http://sigrok.org
  82