xref: /nrf52832-nimble/rt-thread/documentation/doxygen/mainpage.h (revision 042d53a763ad75cb1465103098bb88c245d95138)
1 /*
2  * This file is only used for doxygen document generation.
3  */
4 
5 /**
6  * @mainpage Introduction
7  * @author RT-Thread Development Team
8  * @version 1.2.0
9  *
10  * RT-Thread RTOS is an open source embedded real-time operating system and is
11  * designed specifically for small memory footprint platforms. The real-time and
12  * embedded characters are the most significant advantages of RT-Thread.
13  *
14  * - Real-Time Character
15  *
16  * RT-Thread has a real-time operating system kernel, with fully preempted
17  * multi-thread scheduler, inter-thread communication with timing sensitivity
18  * and transparent interrupt handling.
19  *
20  * - Embedded Character
21  *
22  * RT-Thread is suitable for embedded systems for small footprint characters.
23  * The kernel is implemented as a simple C library. The simplest application
24  * costs less than 1 Kbytes RAM on the ARM Cortex-M platform.
25  *
26  * @section kernel_arch RT-Thread Architecture
27  *
28  * RT-Thread system architecture is like:
29  * @image html System_Arch.png "Figure 1: RT-Thread Architecture"
30  *
31  * @section kernel_service Kernel API
32  *
33  * The Kernel APIs are the core APIs of RT-Thread, which supports the following
34  * features:
35  * - Multi-thread management and scheduler
36  * - Synchronization mechanisms, semaphore, recursive mutex and event set
37  * - Inter-thread communication, mailbox and message queue
38  * - Memory management, memory pool and dynamic heap memory management
39  * - Asynchronous timer
40  *
41  * For more details, please refer to @ref Kernel
42  *
43  * @section system_init System Initialization
44  *
45  * Once RT-Thread operating system starts up, the facility in system must be initialized
46  * firstly.
47  *
48  * For more details, please refer to @ref SystemInit
49  */
50