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-qt is a Qt-based GUI for sigrok.
  10
  11
  12 Status
  13 ------
  14
  15 sigrok-qt is currently work in progress. Some basic functionality
  16 is there, but it should still be considered alpha/beta stage software.
  17
  18 There have been no official tarball releases, yet.
  19
  20 Distro packagers should NOT package this, yet.
  21
  22
  23 Requirements
  24 ------------
  25
  26  - git
  27  - g++
  28  - make
  29  - libtool
  30  - pkg-config >= 0.22
  31  - libglib >= 2.28.0
  32  - Qt >= 4.5
  33  - libsigrok >= 0.2.0
  34  - libsigrokdecode >= 0.1.0
  35
  36
  37 Building and installing
  38 -----------------------
  39
  40 In order to get the sigrok-qt source code and build it, run:
  41
  42  $ git clone git://sigrok.org/sigrok-qt
  43  $ cd sigrok-qt
  44  $ qmake
  45  $ make
  46
  47 For installing sigrok-qt:
  48
  49  $ make install
  50
  51 See the following wiki page for more (OS-specific) instructions:
  52
  53  http://sigrok.org/wiki/Building
  54
  55
  56 Copyright and license
  57 ---------------------
  58
  59 sigrok-qt is licensed under the terms of the GNU General Public License
  60 (GPL), version 3 or later.
  61
  62 While some individual source code files are licensed under the GPLv2+, and
  63 some files are licensed under the GPLv3+, this doesn't change the fact that
  64 the program as a whole is licensed under the terms of the GPLv3+ (e.g. also
  65 due to the fact that it links against GPLv3+ libraries).
  66
  67 Please see the individual source files for the full list of copyright holders.
  68
  69
  70 Mailing lists
  71 -------------
  72
  73 There are two mailing lists for sigrok/sigrok-qt:
  74
  75  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  76  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  77
  78
  79 IRC
  80 ---
  81
  82 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  83
  84
  85 Website
  86 -------
  87
  88  http://sigrok.org/wiki/Sigrok-qt
  89