README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 The sigrok project aims at creating a portable, cross-platform,
   6 Free/Libre/Open-Source logic analyzer software that supports various
   7 logic analyzer hardware products.
   8
   9 sigrok-gtk is a GTK+-based GUI for sigrok.
  10
  11
  12 Status
  13 ------
  14
  15 The sigrok-gtk project is currently work in progress. Some basic functionality
  16 is there, but it should still be considered alpha/beta stage software.
  17
  18
  19 Requirements
  20 ------------
  21
  22  - git
  23  - gcc
  24  - make
  25  - autoconf >= 2.63
  26  - automake >= 1.11
  27  - libtool
  28  - pkg-config >= 0.22
  29  - libglib >= 2.22.0
  30  - GTK+ >= 2.22.0
  31  - libsigrok >= 0.1.0
  32
  33
  34 Building and installing
  35 -----------------------
  36
  37 In order to get the sigrok-gtk source code and build it, run:
  38
  39  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
  40  $ cd sigrok/sigrok-gtk
  41  $ ./autogen.sh
  42  $ ./configure
  43  $ make
  44
  45 For installing sigrok-gtk:
  46
  47  $ make install
  48
  49 Please see the following wiki pages for more detailed instructions:
  50
  51  http://sigrok.org/wiki/Linux
  52  http://sigrok.org/wiki/Mac_OS_X
  53  http://sigrok.org/wiki/Windows
  54  http://sigrok.org/wiki/FreeBSD
  55
  56
  57 Mailing lists
  58 -------------
  59
  60 There are two mailing lists for sigrok/sigrok-gtk:
  61
  62  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  63  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  64
  65
  66 IRC
  67 ---
  68
  69 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  70
  71
  72 Website
  73 -------
  74
  75 http://sigrok.org
  76