README

   1
   2 Nice: GLib ICE library
   3 ======================
   4
   5 Copyright
   6 ---------
   7
   8  (C) 2006-2020 Collabora Ltd.
   9  (C) 2006-2011 Nokia Corporation
  10
  11 License
  12 -------
  13
  14 See the file COPYING.
  15
  16 Requirements
  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 >= 0.10.0 (optional)
  24  gstreamer-1.0 (optional)
  25
  26 Build instructions
  27 ------------------
  28
  29 To build, you need Python 3 and Meson. Then need to do:
  30   meson build && ninja -C build && sudo ninja -C build install
  31
  32 Structure
  33 ---------
  34
  35  agent/   - ICE agent
  36  docs/    - Design and API documentation
  37  gst/     - Gstreamer elements
  38  nice/    - libnice library
  39  random/  - random number generation
  40  socket/  - Socket abstraction layer
  41  stun/    - STUN implementation
  42  tests/   - Unit tests
  43
  44 Relevant standards
  45 ------------------
  46
  47 These standards are relevant to nice's current implementation.
  48
  49 ICE
  50   http://tools.ietf.org/html/rfc5245 (old)
  51   http://tools.ietf.org/html/rfc8445
  52 STUN
  53   http://tools.ietf.org/html/rfc3489 (old)
  54   http://tools.ietf.org/html/rfc5389
  55 TURN
  56   http://tools.ietf.org/html/rfc5766
  57 RTP
  58   http://tools.ietf.org/html/rfc3550
  59 ICE-TCP RFC
  60   http://tools.ietf.org/html/rfc6544
  61 Trickle ICE
  62    https://tools.ietf.org/html/draft-ietf-ice-trickle-21
  63 XMPP Jingle ICE transport
  64   http://www.xmpp.org/extensions/xep-0176.html
  65
  66 In future, nice may additionally support the following standards.
  67
  68 NAT-PMP
  69   http://files.dns-sd.org/draft-cheshire-nat-pmp.txt
  70
  71