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 Requirements for the C library:
  31
  32  - git (only needed when building from git)
  33  - gcc (>= 4.0) or clang
  34  - make
  35  - autoconf >= 2.63 (only needed when building from git)
  36  - automake >= 1.11 (only needed when building from git)
  37  - libtool (only needed when building from git)
  38  - pkg-config >= 0.22
  39  - libglib >= 2.32.0
  40  - libzip >= 0.10
  41  - libserialport >= 0.1.1 (optional, used by some drivers)
  42  - librevisa >= 0.0.20130412 (optional, used by some drivers)
  43  - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
  44  - libftdi >= 0.16 or libftdi1 >= 1.0 (optional, used by some drivers)
  45  - libgpib (optional, used by some drivers)
  46  - libieee1284 (optional, used by some drivers)
  47  - check >= 0.9.4 (optional, only needed to run unit tests)
  48  - doxygen (optional, only needed for the C API docs)
  49  - graphviz (optional, only needed for the C API docs)
  50
  51 Requirements for the C++ bindings:
  52
  53  - libsigrok >= 0.4.0 (the libsigrok C library, see above)
  54  - A C++ compiler with C++11 support (-std=c++11 option), e.g.
  55    - g++ (>= 4.8.1)
  56    - clang++ (>= 3.3)
  57  - autoconf-archive (only needed when building from git)
  58  - doxygen (required for building the bindings, not only for C++ API docs!)
  59  - graphviz (optional, only needed for the C++ API docs)
  60  - Python (2 or 3) executable (development files are not needed)
  61  - glibmm-2.4 (>= 2.32.0)
  62
  63 Requirements for the Python bindings:
  64
  65  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
  66  - Python >= 2.7 or Python >= 3 (including development files!)
  67  - Python setuptools (for Python 2 or 3)
  68  - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
  69  - numpy (for Python 2 or 3)
  70  - SWIG >= 2.0.0
  71  - doxygen (optional, only needed for the Python API docs)
  72  - graphviz (optional, only needed for the Python API docs)
  73  - doxypy (optional, only needed for the Python API docs)
  74
  75 Requirements for the Ruby bindings:
  76
  77  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
  78  - Ruby >= 1.9.3 (including development files!)
  79  - SWIG >= 3.0.8
  80  - YARD (optional, only needed for the Ruby API docs)
  81
  82 Requirements for the Java bindings:
  83
  84  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
  85  - SWIG >= 2.0.0
  86  - Java JDK (for JNI includes and the javac/jar binaries)
  87  - doxygen (optional, only needed for the Java API docs)
  88  - graphviz (optional, only needed for the Java API docs)
  89
  90
  91 Building and installing
  92 -----------------------
  93
  94 In order to get the libsigrok source code and build it, run:
  95
  96  $ git clone git://sigrok.org/libsigrok
  97  $ cd libsigrok
  98  $ ./autogen.sh
  99  $ ./configure
 100  $ make
 101
 102 For installing libsigrok:
 103
 104  $ make install
 105
 106 See INSTALL or the following wiki page for more (OS-specific) instructions:
 107
 108  http://sigrok.org/wiki/Building
 109
 110 Please also check the following wiki page in case you encounter any issues:
 111
 112  http://sigrok.org/wiki/Building#FAQ
 113
 114
 115 Device-specific issues
 116 ----------------------
 117
 118 Please check README.devices for some notes and hints about device- or
 119 driver-specific issues to be aware of.
 120
 121
 122 Firmware
 123 --------
 124
 125 Some devices supported by libsigrok need a firmware to be uploaded before the
 126 device can be used. See README.devices for details.
 127
 128
 129 Copyright and license
 130 ---------------------
 131
 132 libsigrok is licensed under the terms of the GNU General Public License
 133 (GPL), version 3 or later.
 134
 135 While some individual source code files are licensed under the GPLv2+, and
 136 some files are licensed under the GPLv3+, this doesn't change the fact that
 137 the library as a whole is licensed under the terms of the GPLv3+.
 138
 139 Please see the individual source files for the full list of copyright holders.
 140
 141
 142 Mailing list
 143 ------------
 144
 145  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 146
 147
 148 IRC
 149 ---
 150
 151 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 152
 153
 154 Website
 155 -------
 156
 157  http://sigrok.org/wiki/Libsigrok
 158