summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDafydd Harries <dafydd.harries@collabora.co.uk>2007-01-22 11:58:00 +0000
committerDafydd Harries <dafydd.harries@collabora.co.uk>2007-01-22 11:58:00 +0000
commit1d95dcc545dcfeede4e6677904164264bcc02d0a (patch)
treec2c0c7b7b8e6d8c2e3f79a410c1355dca57850c2 /README
parentfc1ce1abe3ef2497af15a41e542d258bf8927688 (diff)
downloadlibnice-1d95dcc545dcfeede4e6677904164264bcc02d0a.tar.gz
README: reformat, add notes on structure, pkg-config dependency
darcs-hash:20070122115851-c9803-5b2e1c0748d69ebdc72e73731cb037f3cfc42586.gz
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 17 insertions, 4 deletions
diff --git a/README b/README
index d9199e0..4e3c11b 100644
--- a/README
+++ b/README
@@ -1,8 +1,9 @@
Nice: GLib ICE library
-----------------------
+======================
-Copyright:
+Copyright
+---------
(C) 2006, 2007 Collabora Ltd.
(C) 2006, 2007 Nokia Corporation
@@ -21,14 +22,26 @@ Copyright:
along with this library; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Requires:
+Requirements
+------------
glib >= 2.10
check >= 0.9.4 (for make check)
+ pkg-config
-Limitations:
+Limitations
+-----------
- ICE agent only supports passive operation
- no support for RTCP
- no support for IPv6
+Structure
+---------
+
+ local/ - local address gathering code
+ stun/ - STUN implementation
+ udp/ - UDP abstraction layer
+ agent/ - ICE agent
+ nice/ - libnice
+