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-meter is a special-purpose GUI for libsigrok (written in Python + Qt)
  10 which supports certain classes of test & measurement devices that usually
  11 provide slowly-updating measurement values, such as multimeters or dataloggers.
  12
  13 It does specifically NOT support logic analyzers, oscilloscopes, and
  14 mixed-signal oscilloscopes (MSOs).
  15
  16
  17 Status
  18 ------
  19
  20 There have been no official tarball releases, yet.
  21
  22 Distro packagers should NOT package this, yet.
  23
  24
  25 Requirements
  26 ------------
  27
  28  - git
  29  - Python (2 or 3)
  30  - PyQt4 or PySide
  31    (both need at least the QtCore and QtGui components)
  32  - PyQtGraph
  33  - libsigrok >= 0.4.0 (including the Python bindings)
  34
  35
  36 Building and installing
  37 -----------------------
  38
  39 In order to get the sigrok-meter source code and build it, run:
  40
  41  $ git clone git://sigrok.org/sigrok-meter
  42  $ cd sigrok-meter
  43  $ make
  44  $ ./sigrok-meter
  45
  46 For installing sigrok-meter:
  47
  48  TODO.
  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-meter 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+ (e.g. also
  64 due to the fact that it links against GPLv3+ libraries).
  65
  66 Please see the individual source files for the full list of copyright holders.
  67
  68 The sigrok logo is licensed under the CC-BY-SA 3.0 license, the icons from the
  69 Adwaita icon set are dual licenced under CC-BY-SA 3.0 and LGPLv3.
  70
  71
  72 Mailing list
  73 ------------
  74
  75  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  76
  77
  78 IRC
  79 ---
  80
  81 You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
  82
  83
  84 Website
  85 -------
  86
  87  http://sigrok.org/wiki/Sigrok-meter
  88