[Init] Add initial source code

Signed-off-by: Regis Merlino <regis.merlino@intel.com>

1 files changed, 89 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..4c9fe18
--- /dev/null
+++ b/README
@@ -0,0 +1,89 @@
+Introduction:
+-------------
+
+TODO
+
+Compilation
+------------
+
+TODO
+
+Working with the source code repository
+---------------------------------------
+
+dleyna-server can be downloaded, compiled and installed as
+follows:
+
+   Clone repository
+     # git clone git://github.com/01org/dleyna-server.git
+     # cd dleyna-server
+
+   Configure and build
+     # ./autoreconf -i
+     # ./configure
+     # make
+
+   Final installation
+     # sudo make install
+
+These instructions are suitable for users who simply want to install
+and run dleyna-server.  However, developers wishing to contribute
+to the project should follow a separate "Configure and build" step.
+
+   Configure and build
+     # ./bootstrap-configure
+     # make
+
+The script "bootstrap-configure" cleans the repository, calls
+autreconf and then invokes configure with proper settings for
+development.  These settings include the enabling of
+maintainer mode and debugging.
+
+Developers can remove autogenerated files with the following command
+
+     # make maintainer-clean
+
+Configure Options:
+------------------
+
+--enable-werror
+
+This option is disabled by default.  To enable use --enable-werror.
+When enabled, all warnings are treated as errors during compilation.
+Should be enabled during development to ensure that errors do not
+creep into the code base.  This option is enabled by
+bootstrap-configure.
+
+--enable-debug
+
+This option is disabled by default.  To enable use
+--enable-debug. When enabled, the make files produce debug builds.
+This option is enabled by bootstrap-configure.
+
+--enable-optimization
+
+This option is enabled by default. To disable use
+--disable-optimization. When enabled it turns on compiler
+optimizations. Disable = -O0, enable = -O2.
+
+--enable-never-quit
+
+This option is disabled by default.  To enable use --enable-never-quit.
+When enabled, media-service-upnp doesn't quit when the last client disconnects.
+
+--with-log-type
+
+See logging.txt for more information about logging.
+
+--with-log-level
+
+See logging.txt for more information about logging.
+
+--with_connector-name
+
+Set the IPC mechanism to be used.
+
+--enable-lib-only
+
+This option is disabled by default. To enable use --enable-lib-only.
+When enabled, only the libdleyna-server library is built.