README 1.43 KB
Newer Older
1 2

Nice: GLib ICE library
3
======================
4

5 6
Copyright
---------
7

Olivier Crête's avatar
Olivier Crête committed
8
 (C) 2006-2018 Collabora Ltd.
Youness Alaoui's avatar
Youness Alaoui committed
9
 (C) 2006-2011 Nokia Corporation
10

11 12
License
-------
13

14
See the file COPYING.
15

16 17
Requirements
------------
18

19
 glib >= 2.54
20
 pkg-config
21
 gnutls >= 2.12.0 or OpenSSL
Youness Alaoui's avatar
Youness Alaoui committed
22 23
 gupnp-igd >= 0.1.2 (optional)
 gstreamer-0.10 >= 0.10.0 (optional)
Olivier Crête's avatar
Olivier Crête committed
24
 gstreamer-1.0 (optional)
25

26 27 28 29 30 31 32 33 34
Build instructions
------------------

To build on Linux and Mac, you only need to type the usual commands :
  ./configure && make && sudo make install
Please refer to the INSTALL file for more details.
If you are building from git, you must first run the ./autogen.sh script
to generate the configure file for you.

35 36 37
Structure
---------

Youness Alaoui's avatar
Youness Alaoui committed
38 39 40 41
 agent/   - ICE agent
 docs/    - Design and API documentation
 gst/     - Gstreamer elements
 nice/    - libnice library
42
 random/  - random number generation
Youness Alaoui's avatar
Youness Alaoui committed
43
 socket/  - Socket abstraction layer
44
 stun/    - STUN implementation
Youness Alaoui's avatar
Youness Alaoui committed
45
 tests/   - Unit tests
46

47 48 49 50 51
Relevant standards
------------------

These standards are relevant to nice's current implementation.

Olivier Crête's avatar
Olivier Crête committed
52
ICE RFC 5245
Youness Alaoui's avatar
Youness Alaoui committed
53
  http://tools.ietf.org/html/rfc5245
54 55
STUN
  http://tools.ietf.org/html/rfc3489
56
  http://tools.ietf.org/html/rfc5389
57
TURN 
58
  http://tools.ietf.org/html/rfc5766
59 60 61 62 63 64 65 66 67
RTP
  http://tools.ietf.org/html/rfc3550
XMPP Jingle ICE transport
  http://www.xmpp.org/extensions/xep-0176.html

In future, nice may additionally support the following standards.

NAT-PMP
  http://files.dns-sd.org/draft-cheshire-nat-pmp.txt
68

69