README 1.5 KB
Newer Older
1 2

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

Dafydd Harries's avatar
Dafydd Harries committed
5 6
Copyright
---------
7

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

Dafydd Harries's avatar
Dafydd Harries committed
11 12
License
-------
13

Dafydd Harries's avatar
Dafydd Harries committed
14
See the file COPYING.
15

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

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

25 26 27 28 29 30 31 32 33 34 35 36
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.

To build on Windows, please refer to the README.win32 file for build instructions
using Microsoft Visual Studio.

37 38 39
Structure
---------

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

49 50 51 52 53
Relevant standards
------------------

These standards are relevant to nice's current implementation.

54
ICE draft 15
Youness Alaoui's avatar
Youness Alaoui committed
55
  http://tools.ietf.org/html/rfc5245
56 57
STUN
  http://tools.ietf.org/html/rfc3489
58
  http://tools.ietf.org/html/rfc5389
59
TURN 
Marcus Lundblad's avatar
Marcus Lundblad committed
60
  http://tools.ietf.org/html/rfc5766
61 62 63 64 65 66 67 68 69
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
Marcus Lundblad's avatar
Marcus Lundblad committed
70

71