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