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
  30  - PyQt4
  31  - libsigrok >= 0.3.0 (including the Python bindings)
  32
  33
  34 Building and installing
  35 -----------------------
  36
  37 In order to get the sigrok-meter source code and build it, run:
  38
  39  $ git clone git://sigrok.org/sigrok-meter
  40  $ cd sigrok-meter
  41  $ ./sigrok-meter
  42
  43 For installing sigrok-meter:
  44
  45  TODO.
  46
  47 See INSTALL or the following wiki page for more (OS-specific) instructions:
  48
  49  http://sigrok.org/wiki/Building
  50
  51
  52 Copyright and license
  53 ---------------------
  54
  55 sigrok-meter is licensed under the terms of the GNU General Public License
  56 (GPL), version 3 or later.
  57
  58 While some individual source code files are licensed under the GPLv2+, and
  59 some files are licensed under the GPLv3+, this doesn't change the fact that
  60 the program as a whole is licensed under the terms of the GPLv3+ (e.g. also
  61 due to the fact that it links against GPLv3+ libraries).
  62
  63 Please see the individual source files for the full list of copyright holders.
  64
  65
  66 Mailing list
  67 ------------
  68
  69  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  70
  71
  72 IRC
  73 ---
  74
  75 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  76
  77
  78 Website
  79 -------
  80
  81  http://sigrok.org/wiki/Sigrok-meter
  82