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-util is a collection of various sigrok-related utilities.
  10
  11
  12 Status
  13 ------
  14
  15 sigrok-util is in development and has not yet had official tarball releases.
  16
  17 Distro packagers should NOT package this, yet.
  18
  19
  20 Requirements
  21 ------------
  22
  23  - git
  24  - Python >= 3.0
  25
  26
  27 Building and installing
  28 -----------------------
  29
  30 In order to get the sigrok-util source code and build it, run:
  31
  32  $ git clone git://sigrok.org/sigrok-util
  33  $ cd sigrok-util
  34  $ make
  35
  36 For installing sigrok-util:
  37
  38  $ make install
  39
  40 Please see the following wiki pages for more detailed instructions:
  41
  42  http://sigrok.org/wiki/Linux
  43  http://sigrok.org/wiki/Mac_OS_X
  44  http://sigrok.org/wiki/Windows
  45  http://sigrok.org/wiki/FreeBSD
  46
  47
  48 Mailing lists
  49 -------------
  50
  51 There are two mailing lists for sigrok/sigrok-util:
  52
  53  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  54  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  55
  56
  57 IRC
  58 ---
  59
  60 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  61
  62
  63 Website
  64 -------
  65
  66  http://sigrok.org/wiki/Sigrok-util
  67