1
2Nice: GLib ICE library
3======================
4
5Copyright
6---------
7
8 (C) 2006-2020 Collabora Ltd.
9 (C) 2006-2011 Nokia Corporation
10
11License
12-------
13
14See the file COPYING.
15
16Requirements
17------------
18
19 glib >= 2.54
20 pkg-config
21 gnutls >= 2.12.0 or OpenSSL
22 gupnp-igd >= 0.1.2 (optional)
23 gstreamer-0.10 (optional)
24 gstreamer-1.0 (optional)
25
26Build instructions
27------------------
28
29libnice uses the Meson Build System: https://mesonbuild.com
30
31To build on Linux and Mac, you only need to type the usual commands :
32
33  meson builddir
34  ninja -C builddir
35  ninja -C builddir test (or "meson test -C builddir" for more control)
36  sudo ninja -C builddir install
37
38See https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project
39for more details and how to install the Meson build system.
40
41Structure
42---------
43
44 agent/   - ICE agent
45 docs/    - Design and API documentation
46 gst/     - Gstreamer elements
47 nice/    - libnice library
48 random/  - random number generation
49 socket/  - Socket abstraction layer
50 stun/    - STUN implementation
51 tests/   - Unit tests
52
53Relevant standards
54------------------
55
56These standards are relevant to nice's current implementation.
57
58ICE
59  http://tools.ietf.org/html/rfc5245 (old)
60  http://tools.ietf.org/html/rfc8445
61STUN
62  http://tools.ietf.org/html/rfc3489 (old)
63  http://tools.ietf.org/html/rfc5389
64TURN
65  http://tools.ietf.org/html/rfc5766
66RTP
67  http://tools.ietf.org/html/rfc3550
68ICE-TCP RFC
69  http://tools.ietf.org/html/rfc6544
70Trickle ICE
71   https://tools.ietf.org/html/draft-ietf-ice-trickle-21
72XMPP Jingle ICE transport
73  http://www.xmpp.org/extensions/xep-0176.html
74
75In future, nice may additionally support the following standards.
76
77NAT-PMP
78  http://files.dns-sd.org/draft-cheshire-nat-pmp.txt
79
80
81