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-test is a collection of various tools and files for testing sigrok.
  10
  11
  12 Status
  13 ------
  14
  15 Work in progress.
  16
  17 Distro packagers should NOT package this!
  18
  19
  20 Requirements
  21 ------------
  22
  23  - git
  24  - gcc
  25  - make
  26  - autoconf >= 2.63
  27  - automake >= 1.11
  28  - pkg-config >= 0.22
  29  - libglib >= 2.24.0
  30  - Python >= 3.2
  31  - libsigrok >= 0.3.0
  32  - libsigrokdecode >= 0.4.0
  33  - python3-coverage
  34
  35
  36 Building and usage
  37 ------------------
  38
  39 Assumption: libsigrok and libsigrokdecode are installed in $HOME/sr.
  40 If they are in a standard location instead, you don't need the
  41 PKG_CONFIG_PATH and LD_LIBRARY_PATH below.
  42
  43 In order to get the sigrok-test source code and build it, run:
  44
  45  $ git clone git://sigrok.org/sigrok-test
  46  $ cd sigrok-test
  47  $ PKG_CONFIG_PATH=$HOME/sr/lib/pkgconfig ./configure \
  48         --with-decodersdir=/path/to/decoders
  49  $ make
  50
  51 This will test the decoders located at /path/to/decoders:
  52
  53  $ LD_LIBRARY_PATH=$HOME/sr/lib ./decoder/pdtest -r -v -a
  54
  55
  56 Copyright and license
  57 ---------------------
  58
  59 sigrok-test contains various tools that are licensed under different terms.
  60
  61 Some are licensed under the terms of the GNU GPL version 2 (or later),
  62 others under the terms of the GNU GPL version 3 (or later).
  63
  64 Please see the individual source files for the full list of copyright holders
  65 and the license that applies to the respective tool.
  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 Freenode.
  78
  79
  80 Website
  81 -------
  82
  83  http://sigrok.org
  84