README.md

   1 libswo
   2 ======
   3
   4 libswo is a shared library written in C to decode SWO trace data.
   5
   6
   7 Requirements
   8 ------------
   9
  10 libswo depends on the following packages:
  11
  12  - GCC (>= 4.0) or Clang
  13  - Make
  14  - pkg-config >= 0.23
  15  - Doxygen (optional, only required for API documentation)
  16
  17 If you're building libswo from Git, the following packets are additionally
  18 required:
  19
  20  - Git
  21  - Libtool
  22  - Autoconf >= 2.64
  23  - Automake >= 1.9
  24
  25 Requirements for the C++ bindings:
  26
  27  - libswo >= 0.1.0
  28  - C++ compiler with C++11 support, e.g.
  29    - GCC >= 4.7
  30    - Clang >= 3.0
  31
  32 Requirements for the Python bindings:
  33
  34  - libswocxx >= 0.1.0 (libswo C++ bindings, see above)
  35  - Python >= 3.2
  36  - Python setuptools
  37  - SWIG >= 3.0.3
  38
  39
  40 Building and installing
  41 -----------------------
  42
  43 In order to get and build the latest Git version of libswo, run the following
  44 commands:
  45
  46     $ git clone https://gitlab.zapb.de/zapb/libswo.git
  47     $ cd libswo
  48     $ ./autogen.sh
  49     $ ./configure
  50     $ make
  51
  52 After `make` finishes without any errors, use the following command to install
  53 libswo:
  54
  55     $ make install
  56
  57
  58 Copyright and license
  59 ---------------------
  60
  61 libswo is licensed under the terms of the GNU General Public License (GPL),
  62 version 3 or later. See COPYING file for details.
  63
  64
  65 Website
  66 -------
  67
  68 <https://gitlab.zapb.de/zapb/libswo.git>