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 Requirements
  15 ------------
  16
  17  - git
  18  - gcc (>= 4.0)
  19  - make
  20  - autoconf >= 2.63
  21  - automake >= 1.11
  22  - libtool
  23  - pkg-config >= 0.22
  24  - libglib >= 2.22.0
  25  - Python >= 3.0
  26
  27
  28 Building and installing
  29 -----------------------
  30
  31 In order to get the libsigrokdecode source code and build it, run:
  32
  33  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
  34  $ cd sigrok/libsigrokdecode
  35  $ ./autogen.sh
  36  $ ./configure
  37  $ make
  38
  39 For installing libsigrokdecode:
  40
  41  $ make install
  42
  43 Please see the following wiki pages for more detailed instructions:
  44
  45  http://sigrok.org/wiki/Linux
  46  http://sigrok.org/wiki/Mac_OS_X
  47  http://sigrok.org/wiki/Windows
  48  http://sigrok.org/wiki/FreeBSD
  49
  50
  51 Mailing lists
  52 -------------
  53
  54 There are two mailing lists for sigrok/libsigrokdecode:
  55
  56  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  57  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  58
  59
  60 IRC
  61 ---
  62
  63 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  64
  65
  66 Website
  67 -------
  68
  69 http://sigrok.org
  70