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 libsigrok is a shared library written in C which provides the basic API
  10 for talking to hardware and reading/writing the acquired data into various
  11 input/output file formats.
  12
  13
  14 Status
  15 ------
  16
  17 libsigrok is in a usable state and has had official tarball releases.
  18
  19 While the API can change from release to release, this will always be
  20 properly documented and reflected in the package version number and
  21 in the shared library / libtool / .so-file version numbers.
  22
  23 However, there are _NO_ guarantees at all for stable APIs in git snapshots!
  24 Distro packagers should only use released tarballs (no git snapshots).
  25
  26
  27 Requirements
  28 ------------
  29
  30  - git
  31  - gcc (>= 4.0)
  32  - make
  33  - autoconf >= 2.63
  34  - automake >= 1.11
  35  - libtool
  36  - pkg-config >= 0.22
  37  - libglib >= 2.32.0
  38  - libzip >= 0.10
  39  - libserialport >= 0.1.0 (optional, used by some drivers)
  40  - librevisa >= 0.0.20130812 (optional, used by some drivers)
  41  - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
  42  - libftdi >= 0.16 or libftdi1 >= 1.0 (optional, used by some drivers)
  43  - check >= 0.9.4 (optional, only needed to run unit tests)
  44
  45
  46 Building and installing
  47 -----------------------
  48
  49 In order to get the libsigrok source code and build it, run:
  50
  51  $ git clone git://sigrok.org/libsigrok
  52  $ cd libsigrok
  53  $ ./autogen.sh
  54  $ ./configure
  55  $ make
  56
  57 For installing libsigrok:
  58
  59  $ make install
  60
  61 See INSTALL or the following wiki page for more (OS-specific) instructions:
  62
  63  http://sigrok.org/wiki/Building
  64
  65
  66 Device-specific issues
  67 ----------------------
  68
  69 Please check README.devices for some notes and hints about device- or
  70 driver-specific issues to be aware of.
  71
  72
  73 Firmware
  74 --------
  75
  76 Some devices supported by libsigrok need a firmware to be uploaded before the
  77 device can be used. See README.devices for details.
  78
  79
  80 Copyright and license
  81 ---------------------
  82
  83 libsigrok is licensed under the terms of the GNU General Public License
  84 (GPL), version 3 or later.
  85
  86 While some individual source code files are licensed under the GPLv2+, and
  87 some files are licensed under the GPLv3+, this doesn't change the fact that
  88 the library as a whole is licensed under the terms of the GPLv3+.
  89
  90 Please see the individual source files for the full list of copyright holders.
  91
  92
  93 Mailing lists
  94 -------------
  95
  96 There are two mailing lists for sigrok/libsigrok:
  97
  98  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  99  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 100
 101
 102 IRC
 103 ---
 104
 105 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 106
 107
 108 Website
 109 -------
 110
 111  http://sigrok.org/wiki/Libsigrok
 112