[README] Revise README.md in root dir to add useful info

This commit revises README.md in root dir to add useful info.

Signed-off-by: Dongju Chae <dongju.chae@samsung.com>

diff --git a/README.md b/README.md
index c6b4bd7..e9e97ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,28 @@
 
 [![Code Coverage](https://nnsuiteci.mooo.com/NPU_SystemService/ci/badge/codecoverage.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/index.html) [![Unit Test](https://nnsuiteci.mooo.com/NPU_SystemService/ci/badge/unittest.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/unittest_result/)
 
+## Directory Structure
+```
+NPU_SystemService/    Root directory
+|-- src/
+|   |-- core/         Source files for NPU Engine
+|   |-- host/         Source files for Host Lib (not used currently)
+|   `-- test/
+|       |-- unittests Source files for UnitTests
+|       `-- apptests  Source files for AppTests
+|-- include/
+|   |-- common/       Definitions for Common Data
+|   `-- host/         Definitions for User APIs
+|-- packaging/        Tizen Packaging Files
+`-- debian/           Debian Packaging Files (not supported currently)
+```
+
+## Useful Manuals
+- How to use the NPU Engine library in user apps: [here](./include/README.md)
+- How to run the FastModel simulator: [here](https://github.sec.samsung.net/AIP/NPU_bootstrap/blob/master/README.md)
+
+## Reference Links
 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
-- Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf 
+- Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf