README.md

   1 # libjaylink
   2
   3 libjaylink is a shared library written in C to access SEGGER J-Link and
   4 compatible devices.
   5
   6
   7 ## Requirements
   8
   9 libjaylink requires the following packages:
  10
  11  - GCC (>= 4.0) or Clang
  12  - Make
  13  - pkg-config >= 0.23
  14  - libusb >= 1.0.9 (optional)
  15  - Doxygen (optional, only required for API documentation)
  16
  17 If you're building libjaylink from Git, the following packages are additionally
  18 required:
  19
  20  - Git
  21  - Libtool
  22  - Autoconf >= 2.64
  23  - Automake >= 1.9
  24
  25
  26 ## Building and installing
  27
  28 In order to get and build the latest Git version of libjaylink, run the
  29 following commands:
  30
  31     $ git clone https://gitlab.zapb.de/libjaylink/libjaylink.git
  32     $ cd libjaylink
  33     $ ./autogen.sh
  34     $ ./configure
  35     $ make
  36
  37 After `make` finishes without any errors, use the following command to install
  38 libjaylink:
  39
  40     $ make install
  41
  42
  43 ## Portability
  44
  45 libjaylink supports the following operating systems:
  46
  47  - GNU/Linux
  48  - FreeBSD
  49  - OpenBSD
  50  - NetBSD
  51  - Microsoft Windows
  52    - Cygwin, MinGW and MSYS2
  53  - OS X
  54
  55
  56 ## Copyright and license
  57
  58 libjaylink is licensed under the terms of the GNU General Public License (GPL),
  59 version 2 or later. See COPYING file for details.
  60
  61
  62 ## Website
  63
  64 <https://gitlab.zapb.de/libjaylink/libjaylink.git>