README.md 1.27 KB
Newer Older
Marc Schink's avatar
Marc Schink committed
1
2
3
4
5
6
7
8
9
10
11
12
libjaylink
==========

libjaylink is a shared library written in C to access SEGGER J-Link and
compatible devices.


Requirements
------------

libjaylink requires the following packages:

Marc Schink's avatar
Marc Schink committed
13
14
 - GCC (>= 4.0) or Clang
 - Make
Marc Schink's avatar
Marc Schink committed
15
 - pkg-config >= 0.23
Marc Schink's avatar
Marc Schink committed
16
 - libusb >= 1.0.9 (optional)
Marc Schink's avatar
Marc Schink committed
17
 - Doxygen (optional, only required for API documentation)
Marc Schink's avatar
Marc Schink committed
18
19
20
21

If you're building libjaylink from Git, the following packages are additionally
required:

Marc Schink's avatar
Marc Schink committed
22
23
24
25
 - Git
 - Libtool
 - Autoconf >= 2.64
 - Automake >= 1.9
Marc Schink's avatar
Marc Schink committed
26
27
28
29
30
31
32
33


Building and installing
-----------------------

In order to get and build the latest Git version of libjaylink, run the
following commands:

Marc Schink's avatar
Marc Schink committed
34
    $ git clone https://gitlab.zapb.de/libjaylink/libjaylink.git
Marc Schink's avatar
Marc Schink committed
35
36
37
38
39
40
41
42
43
44
45
    $ cd libjaylink
    $ ./autogen.sh
    $ ./configure
    $ make

After `make` finishes without any errors, use the following command to install
libjaylink:

    $ make install


46
47
48
49
50
51
52
53
54
55
56
57
58
59
Portability
-----------

libjaylink supports the following operating systems:

 - GNU/Linux
 - FreeBSD
 - OpenBSD
 - NetBSD
 - Microsoft Windows
   - Cygwin, MinGW and MSYS2
 - OS X


Marc Schink's avatar
Marc Schink committed
60
61
62
63
Copyright and license
---------------------

libjaylink is licensed under the terms of the GNU General Public License (GPL),
64
version 2 or later. See COPYING file for details.
Marc Schink's avatar
Marc Schink committed
65
66
67
68
69


Website
-------

Marc Schink's avatar
Marc Schink committed
70
<https://gitlab.zapb.de/libjaylink/libjaylink.git>