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  - check >= 0.9.4 (optional, only needed to run unit tests)
  40
  41
  42 Building and installing
  43 -----------------------
  44
  45 In order to get the libsigrokdecode source code and build it, run:
  46
  47  $ git clone git://sigrok.org/libsigrokdecode
  48  $ cd libsigrokdecode
  49  $ ./autogen.sh
  50  $ ./configure
  51  $ make
  52
  53 For installing libsigrokdecode:
  54
  55  $ make install
  56
  57 See INSTALL or the following wiki page for more (OS-specific) instructions:
  58
  59  http://sigrok.org/wiki/Building
  60
  61
  62 Copyright and license
  63 ---------------------
  64
  65 libsigrokdecode is licensed under the terms of the GNU General Public License
  66 (GPL), version 3 or later.
  67
  68 The protocol decoders (PDs) included in libsigrokdecode are an integral part
  69 of the shared library (they are not merely external "plugins", they are not
  70 external programs that libsigrokdecode calls via fork/exec, they cannot
  71 function standalone without libsigrokdecode at all, the PDs and the rest of
  72 the libsigrokdecode codebase share data structures and make function calls
  73 to each other). Thus, since the PDs are part of the library, they are also
  74 licensed under the terms of the GPLv3+.
  75
  76 While some individual source code files are licensed under the GPLv2+, and
  77 some files are licensed under the GPLv3+, this doesn't change the fact that
  78 the library as a whole is licensed under the terms of the GPLv3+.
  79
  80 Please see the individual source files for the full list of copyright holders.
  81
  82
  83 Mailing lists
  84 -------------
  85
  86 There are two mailing lists for sigrok/libsigrokdecode:
  87
  88  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  89  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  90
  91
  92 IRC
  93 ---
  94
  95 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  96
  97
  98 Website
  99 -------
 100
 101  http://sigrok.org/wiki/Libsigrokdecode
 102