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 libsigrok is a shared library written in C which provides the basic API
  10 for talking to logic analyzer hardware and reading/writing the acquired data
  11 into various input/output file formats.
  12
  13
  14 Status and API
  15 --------------
  16
  17 libsigrok is currently work in progress.
  18
  19 IMPORTANT: The API of libsigrok is NOT yet considered stable! Please do
  20            not rely on it, yet! Changes to function names, macro names etc.
  21            can happen at any time without prior notice!
  22
  23
  24 Requirements
  25 ------------
  26
  27  - git
  28  - gcc (>= 4.0)
  29  - make
  30  - autoconf >= 2.63
  31  - automake >= 1.11
  32  - libtool
  33  - pkg-config >= 0.22
  34  - libglib >= 2.22.0
  35  - libusb >= 1.0.5 (for most logic analyzer hardware)
  36  - libzip >= 0.8
  37  - zlib >= 1.2.3.1
  38  - libftdi >= 0.16 (for some logic analyzer hardware)
  39  - libudev >= 151 (for some logic analyzer hardware)
  40
  41
  42 Building and installing
  43 -----------------------
  44
  45 In order to get the libsigrok source code and build it, run:
  46
  47  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
  48  $ cd sigrok/libsigrok
  49  $ ./autogen.sh
  50  $ ./configure
  51  $ make
  52
  53 For installing libsigrok:
  54
  55  $ make install
  56
  57 Please see the following wiki pages for more detailed instructions:
  58
  59  http://sigrok.org/wiki/Linux
  60  http://sigrok.org/wiki/Mac_OS_X
  61  http://sigrok.org/wiki/Windows
  62  http://sigrok.org/wiki/FreeBSD
  63
  64
  65 Mailing lists
  66 -------------
  67
  68 There are two mailing lists for sigrok/libsigrok:
  69
  70  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  71  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  72
  73
  74 IRC
  75 ---
  76
  77 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  78
  79
  80 Website
  81 -------
  82
  83 http://sigrok.org
  84