README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 The sigrok project aims at creating a portable, cross-platform,
   6 Free/Libre/Open-Source signal analysis software suite that supports various
   7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
   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
  15 ------
  16
  17 libsigrokdecode is in a usable state and has had official tarball releases.
  18
  19 While the API can change from release to release, this will always be
  20 properly documented and reflected in the package version number and
  21 in the shared library / libtool / .so-file version numbers.
  22
  23 However, there are _NO_ guarantees at all for stable APIs in git snapshots!
  24 Distro packagers should only use released tarballs (no git snapshots).
  25
  26
  27 Requirements
  28 ------------
  29
  30  - git
  31  - gcc (>= 4.0)
  32  - make
  33  - autoconf >= 2.63
  34  - automake >= 1.11
  35  - libtool
  36  - pkg-config >= 0.22
  37  - libglib >= 2.24.0
  38  - Python >= 3.0
  39
  40
  41 Building and installing
  42 -----------------------
  43
  44 In order to get the libsigrokdecode source code and build it, run:
  45
  46  $ git clone git://sigrok.org/libsigrokdecode
  47  $ cd libsigrokdecode
  48  $ ./autogen.sh
  49  $ ./configure
  50  $ make
  51
  52 For installing libsigrokdecode:
  53
  54  $ make install
  55
  56 Please see the following wiki pages for more detailed instructions:
  57
  58  http://sigrok.org/wiki/Linux
  59  http://sigrok.org/wiki/Mac_OS_X
  60  http://sigrok.org/wiki/Windows
  61  http://sigrok.org/wiki/FreeBSD
  62
  63
  64 Mailing lists
  65 -------------
  66
  67 There are two mailing lists for sigrok/libsigrokdecode:
  68
  69  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  70  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  71
  72
  73 IRC
  74 ---
  75
  76 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  77
  78
  79 Website
  80 -------
  81
  82  http://sigrok.org/wiki/Libsigrokdecode
  83