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-gtk is a GTK+-based GUI for sigrok.
  10
  11
  12 Status
  13 ------
  14
  15 sigrok-gtk 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  - gcc
  28  - make
  29  - autoconf >= 2.63
  30  - automake >= 1.11
  31  - libtool
  32  - pkg-config >= 0.22
  33  - libglib >= 2.28.0
  34  - GTK+ >= 2.22.0
  35  - libsigrok >= 0.2.0
  36
  37
  38 Building and installing
  39 -----------------------
  40
  41 In order to get the sigrok-gtk source code and build it, run:
  42
  43  $ git clone git://sigrok.org/sigrok-gtk
  44  $ cd sigrok-gtk
  45  $ ./autogen.sh
  46  $ ./configure
  47  $ make
  48
  49 For installing sigrok-gtk:
  50
  51  $ make install
  52
  53 See INSTALL or the following wiki page for more (OS-specific) instructions:
  54
  55  http://sigrok.org/wiki/Building
  56
  57
  58 Copyright and license
  59 ---------------------
  60
  61 sigrok-gtk is licensed under the terms of the GNU General Public License
  62 (GPL), version 3 or later.
  63
  64 While some individual source code files are licensed under the GPLv2+, and
  65 some files are licensed under the GPLv3+, this doesn't change the fact that
  66 the program as a whole is licensed under the terms of the GPLv3+.
  67
  68 Please see the individual source files for the full list of copyright holders.
  69
  70
  71 Mailing lists
  72 -------------
  73
  74 There are two mailing lists for sigrok/sigrok-gtk:
  75
  76  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  77  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  78
  79
  80 IRC
  81 ---
  82
  83 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  84
  85
  86 Website
  87 -------
  88
  89  http://sigrok.org/wiki/Sigrok-gtk
  90