Update packaging
[profile/ivi/dLeyna.git] / README
1 Introduction:
2 -------------
3
4 Dleyna-linux is an umbrella project, hosting a number of DLNA middleware
5 components as git submodules:
6
7 git://github.com/01org/dleyna-core.git
8 git://github.com/01org/dleyna-connector-dbus.git
9 git://github.com/01org/dleyna-server.git
10 git://github.com/01org/dleyna-renderer.git
11 git://github.com/01org/dleyna-control.git
12
13 Submodules contents are meant to be read-only to ensure consistency
14 between the various components.
15
16 The project is targeting the linux platform, using d-bus as the IPC
17 mechanism for client applications to access its services.
18
19 See each submodule documentation for details.
20
21
22 Compilation
23 ------------
24
25 Dleyna-linux is built using autotools and gcc.  It also has a
26 number of dependencies on third party libraries, notably glib, gupnp,
27 gssdp and gupnp-av.  Both development versions of these libraries
28 and autotools need to be installed before dleyna-linux can be
29 compiled.  On Ubuntu 11.10 autotools and the glib development libraries can
30 be installed with the following commands.
31
32 sudo apt-get install autoconf
33 sudo apt-get install libglib2.0-dev
34
35 The development version of d-Bus is also required.  This can be
36 installed on Ubuntu by typing:
37
38 sudo apt-get install libdbus-1-dev
39
40
41 Working with the source code repository
42 ---------------------------------------
43
44 Dleyna-linux can be downloaded, compiled and installed as
45 follows:
46
47    Clone repository
48      # git clone git://github.com/01org/dleyna-linux.git
49      # cd dleyna-linux
50
51    Update submodules
52      # git submodule init
53      # git submodule update
54
55    Configure and build
56      # ./autogen.sh
57      # make
58
59    Final installation
60      # sudo make install
61
62 These instructions are suitable for users who simply want to install
63 dleyna-linux services.  However, developers wishing to contribute
64 to the project should follow a separate "Configure and build" step.
65
66    Configure and build
67      # ./bootstrap-configure
68      # make
69
70 The script "bootstrap-configure" cleans the repository, calls
71 autreconf and then invokes configure with proper settings for
72 development.  These settings include the enabling of
73 maintainer mode and debugging.
74
75 Developers can remove autogenerated files with the following command
76
77      # make maintainer-clean
78
79