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, make, ...
  24  - autoconf, automake, libtool, pkg-config
  25  - libglib >= 2.22.0
  26  - GTK+ >= 2.22.0
  27  - libsigrok
  28
  29
  30 Building and installing
  31 -----------------------
  32
  33 In order to get the sigrok-gtk source code and build it, run:
  34
  35  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
  36  $ cd sigrok/sigrok-gtk
  37  $ ./autogen.sh
  38  $ ./configure
  39  $ make
  40
  41 For installing sigrok-gtk:
  42
  43  $ make install
  44
  45 Please see the following wiki pages for more detailed instructions:
  46
  47  http://sigrok.org/wiki/Linux
  48  http://sigrok.org/wiki/Mac_OS_X
  49  http://sigrok.org/wiki/Windows
  50  http://sigrok.org/wiki/FreeBSD
  51
  52
  53 Mailing lists
  54 -------------
  55
  56 There are two mailing lists for sigrok/sigrok-gtk:
  57
  58  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  59  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  60
  61
  62 IRC
  63 ---
  64
  65 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  66
  67
  68 Website
  69 -------
  70
  71 http://sigrok.org
  72