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 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 The sigrok-cli project, while still in development, is pretty stable/usable.
  18
  19
  20 Requirements
  21 ------------
  22
  23  - git
  24  - gcc
  25  - make
  26  - autoconf >= 2.63
  27  - automake >= 1.11
  28  - libtool
  29  - pkg-config >= 0.22
  30  - libglib >= 2.22.0
  31  - libsigrok >= 0.1.0
  32  - libsigrokdecode >= 0.1.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.git.sourceforge.net/gitroot/sigrok/sigrok
  41  $ cd sigrok/sigrok-cli
  42  $ ./autogen.sh
  43  $ ./configure
  44  $ make
  45
  46 For installing sigrok-cli:
  47
  48  $ make install
  49
  50 Please see the following wiki pages for more detailed instructions:
  51
  52  http://sigrok.org/wiki/Linux
  53  http://sigrok.org/wiki/Mac_OS_X
  54  http://sigrok.org/wiki/Windows
  55  http://sigrok.org/wiki/FreeBSD
  56
  57
  58 Mailing lists
  59 -------------
  60
  61 There are two mailing lists for sigrok/sigrok-cli:
  62
  63  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  64  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  65
  66
  67 IRC
  68 ---
  69
  70 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  71
  72
  73 Website
  74 -------
  75
  76 http://sigrok.org
  77