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