[README/DOC] Revise README.md and add some documentation
[platform/adaptation/npu/trix-engine.git] / README.md
1 ## NPU SystemService
2
3 [![Code Coverage](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/codecoverage.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/index.html) [![Unit Test](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/unittest.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/unittest_result/)
4
5 ## Directory Structure
6 ```
7 NPU_SystemService/    Root directory
8 |-- src/
9 |   |-- core/         Source files for NPU Engine
10 |   |-- host/         Source files for Host Lib (not used currently)
11 |   `-- test/
12 |       |-- unittests Source files for UnitTests
13 |       |-- apptests  Source files for AppTests
14 |       `-- testdata  Testdata for tests
15 |-- include/
16 |   |-- common/       Definitions for Common Data
17 |   `-- host/         Definitions for User APIs
18 |-- packaging/        Tizen Packaging Files (i.e., FastModel Simulator)
19 |-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04)
20 `-- doc/              Documentation
21 ```
22
23 ## Getting Started
24 - How to setup your own FastModel enviornment: press [here](https://github.sec.samsung.net/AIP/NPU_bootstrap/blob/master/README.md)
25 - How to build the NPU Engine library (FastModel or Ubuntu): press [here](/doc/how_to_build.md)
26 - How to use the NPU Engine library in user apps: press [here](/doc/how_to_use.md)
27 - Usage examples using the NPU Engine library: press [here](/doc/usage_examples.md)
28
29 ## Reference Links
30 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
31 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
32 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
33 - Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf