From: Boram Park <boram1288.park@samsung.com>
Date: Wed, 30 Dec 2015 02:41:43 +0000 (+0900)
Subject: add README file
X-Git-Tag: accepted/tizen/mobile/20160122.080623~5
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=88d3de8a4100afe907f9e873c2d037e5e6c99396;p=platform%2Fcore%2Fuifw%2Flibtdm.git

add README file

Change-Id: I54495cefc4dcf7d2467a6bf5e8aaf4d6675a70e5
---

diff --git a/README b/README
new file mode 100644
index 0000000..d425bb8
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+libtdm - Tizen Display Manager
+
+It's the display HAL layer for tizen display server. It offers the frontend
+APIs(tdm.h) for a frontend user and the abstraction interface(tdm_backend.h)
+for a hardware vendor.
+
+TDM consists of display/output/layer/pp/capture objects. A frontend user can
+get the output/layer/pp/capture hardware information with each object.
+Basically, TDM supposes that all hardware devices have fixed outputs and layers.
+
+All changes of output/layer/pp/capture objects are applied when committed.
+
+TDM has its own buffer release mechanism to let an user know when a TDM buffer
+becomes available for a next job.
+
+Doxygen document
+----------------
+- The doxygen document is created in the "doc/html" directory.
+- How to create the doxygen document
+  $ doxygen doc/Doxyfile
+- How to view the doxygen document
+  $ firefox doc/html/index.html