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