[README/Doc] Update README/doc texts about SPIN/ubuntu support
[platform/adaptation/npu/trix-engine.git] / README.md
1 ## NPU SystemService (compatible with both TRIV1 and TRIV2)
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/) [![SAM Score](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/samscore.svg)](https://code.sec.samsung.net/architecturemanager/app/sam/NPU_SystemService/npu-engine/latest/overview)
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 |-- include/
12 |   |-- common/       Definitions for Common Data
13 |   |-- host/         Definitions for User APIs
14 |-- tests/
15 |   |-- unittests     Source files for Unit Tests
16 |   |-- apptests      Source files for App Tests
17 |   `-- utils         Source files for Test Utils
18 |-- packaging/        Tizen Packaging Files (i.e., FastModel Simulator)
19 |-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04/18.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 ## Related Projects
30 - NPU SystemService's testdata: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata)
31 - NPU SystemService's NPU emulator: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Emulator)
32
33 ## SPIN Repository (to download official packages)
34 - How to create your SPIN account: press [here](https://code.sec.samsung.net/confluence/display/NEWCOMM/SPIN+Request+Process)
35 - Tizen: http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard
36 - Ubuntu (16.04/18.04): http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools
37
38 ## Reference Links
39 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
40 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
41 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
42 - Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf