docs: Add overview documentation.
[profile/ivi/rygel.git] / doc / reference / librygel-server / gtkdoc / overview.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5 ]>
6
7 <section id="overview">
8
9 <para>
10 librygel-server is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
11 </para>
12
13 <para>
14 This library may be used to create UPnP or DLNA servers via its
15 The <link linkend="RygelMediaServer">RygelMediaServer</link>.
16 </para>
17
18 <!-- TODO: Find a way to mention this C example code in the RygelMediaServer valadoc comments instead. -->
19 <para>
20 This example program shows how to fill a container with media items and then instantiate a server to serve 
21 them.
22 </para>
23 <programlisting role="C">
24   <xi:include  href="../../../../examples/standalone-server.c"
25     parse="text"
26     xmlns:xi="http://www.w3.org/2001/XInclude"/>
27 </programlisting>
28
29 <para>
30 librygel-server is licensed under the GNU Lesser General Public License (LGPL).
31 </para>
32
33 </section>