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 sigrok-cli is a command-line tool written in C, which uses both libsigrok
  10 and libsigrokdecode to provide the basic sigrok functionality from the
  11 command-line. Among other things, it's useful for scripting purposes.
  12
  13
  14 Status
  15 ------
  16
  17 sigrok-cli is in a usable state and has had official tarball releases.
  18
  19
  20 Requirements
  21 ------------
  22
  23  - git (only needed when building from git)
  24  - gcc or clang
  25  - make
  26  - autoconf >= 2.63 (only needed when building from git)
  27  - automake >= 1.11 (only needed when building from git)
  28  - libtool (only needed when building from git)
  29  - pkg-config >= 0.22
  30  - libglib >= 2.32.0
  31  - libsigrok >= 0.5.0
  32  - libsigrokdecode >= 0.5.0
  33
  34
  35 Building and installing
  36 -----------------------
  37
  38 In order to get the sigrok-cli source code and build it, run:
  39
  40  $ git clone git://sigrok.org/sigrok-cli
  41  $ cd sigrok-cli
  42  $ ./autogen.sh
  43  $ ./configure
  44  $ make
  45
  46 For installing sigrok-cli:
  47
  48  $ make install
  49
  50 See INSTALL or the following wiki page for more (OS-specific) instructions:
  51
  52  http://sigrok.org/wiki/Building
  53
  54
  55 Copyright and license
  56 ---------------------
  57
  58 sigrok-cli is licensed under the terms of the GNU General Public License
  59 (GPL), version 3 or later.
  60
  61 While some individual source code files are licensed under the GPLv2+, and
  62 some files are licensed under the GPLv3+, this doesn't change the fact that
  63 the program as a whole is licensed under the terms of the GPLv3+.
  64
  65 Please see the individual source files for the full list of copyright holders.
  66
  67
  68 Mailing list
  69 ------------
  70
  71  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  72
  73
  74 IRC
  75 ---
  76
  77 You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
  78
  79
  80 Website
  81 -------
  82
  83  http://sigrok.org/wiki/Sigrok-cli
  84