Update README.md file to describe how to set the feature

Update README.md file to describe how to set the feature value.
It needs to prevent the confusion to update feature value.

Change-Id: Ie28a3e0af46a2925777069844d741f80501807f0
Signed-off-by: Jaehoon Chung <jh80.chung@samsung.com>

diff --git a/README.md b/README.md
index ea246cd..20f5183 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
 # unified-model-config
 Unified Model Config
+
+# How to set model-config
+
+# generic (IoT)
+generic/model-config-iot.xml
+- It'll be included in Tizen Platform Image (Headed/Headless).
+- If feature is provided and dependent to hal backend, it has to set to *true* by default.
+  For example,  If "tizen.org/fature/battery" is dependent to HAL backend, set to true.
+- If feature is not dependent to hal backend, just set to a proper feature value.
+
+generic/model-config-hal.xml
+- It'll be included in HAL Imge.
+- It's feature releated with HAL backend. It has to set to *false* by default.
+- If want to enable some feature according to specific board, it has to be modified the feature
+in tizen/building-block. (packaging/platform-preset-board-<target>-hal-backend.inc)
+- Use %tizen_hal_feature macro in building-block.
+
+Feature is used after "AND" operation with  model-config-iot.xml and modle-config-hal.xml.
+e.g)
+/etc/config/model-config.xml - tizen.org/feature/battery true
+/hal/etc/config/model-config.xml - tizen.org/feature/battery false
+
+Finally, tizen.org/feature/battery is false(true && false).
+
+NOTE: Don't refer to /etc/config/model-config.xml file directly. Use system-info-tool or system-info API.
+
+# rpi3 / tm1 / tw2 / xu3 / tm2 / tw3
+These folders don't use building-block. There is no hal backend image.
+- Update the feature value that it wants to use.