Go to file
liruncong 9f86a17e7b [bsp/imx6sx]rt_hw_interrupt_install函数name参数增加const限定 2018-12-05 20:43:59 +08:00
bsp [bsp/imx6sx]rt_hw_interrupt_install函数name参数增加const限定 2018-12-05 20:43:59 +08:00
components [components/drivers/audio] [修复] audio 中枚举类型不匹配的问题 2018-11-28 18:56:40 +08:00
documentation There is some "micro" word (e.g. section6), maybe "macro"? 2018-09-26 18:48:17 +09:00
examples [examples][network] 更新 TCP/UDP 例程 uage 2018-11-06 09:46:20 +08:00
include [include]rt_hw_interrupt_install函数name参数增加const限定 2018-12-05 20:34:19 +08:00
libcpu [libcpu/mips/ppc405]rt_hw_interrupt_install函数name参数增加const限定 2018-12-05 20:43:42 +08:00
src Add RTT version number on Kconfig file. 2018-11-27 13:47:03 +08:00
tools [tools] fix bug. 2018-11-23 09:23:31 +08:00
.gitattributes update .gitattributes 2013-01-08 23:57:29 +08:00
.gitignore Update .gitignore 2018-11-09 10:08:31 +08:00
.travis.yml Update .travis.yml 2018-11-10 12:22:25 +08:00
AUTHORS update CRLF 2013-01-09 00:06:34 +08:00
ChangeLog.md Update ChangeLog.md 2018-11-14 15:20:24 +08:00
Kconfig [Kconfig] Rename all of KConfig files to 'Kconfig' 2017-11-30 20:12:53 +08:00
LICENSE Update license information. 2018-09-09 11:13:41 +08:00
README.md Update README.md 2018-09-16 18:37:11 +08:00
README_zh.md Update license information. 2018-09-09 11:13:41 +08:00

README.md

RT-Thread

中文页 |

GitHub GitHub release Build Status Gitter GitHub pull-requests PRs Welcome

RT-Thread is an open source IoT operating system from China, which has strong scalability: from a tiny kernel running on a tiny core, for example ARM Cortex-M0, or Cortex-M3/4/7, to a rich feature system running on MIPS32, ARM Cortex-A8, ARM Cortex-A9 DualCore etc.

Overview

RT-Thread RTOS like a traditional real-time operating system. The kernel has real-time multi-task scheduling, semaphore, mutex, mail box, message queue, signal etc. However, it has three different things:

  • Device Driver;
  • Component;
  • Dyanmic Module

The device driver is more like a driver framework, UART, IIC, SPI, SDIO, USB device/host, EMAC, MTD NAND etc. The developer can easily add low level driver and board configuration, then combined with the upper framework, he/she can use lots of features.

The Component is a software concept upon RT-Thread kernel, for example a shell (finsh/msh shell), virtual file system (FAT, YAFFS, UFFS, ROM/RAM file system etc), TCP/IP protocol stack (lwIP), POSIX (thread) interface etc. One component must be a directory under RT-Thread/Components and one component can be descripted by a SConscript file (then be compiled and linked into the system).

The Dyanmic Module, formerly named as User Applicaion (UA) is a dyanmic loaded module or library, it can be compiled standalone without Kernel. Each Dyanmic Module has its own object list to manage thread/semaphore/kernel object which was created or initialized inside this UA. More information about UA, please visit another git repo.

Board Support Package

RT-Thread RTOS can support many architectures:

  • ARM Cortex-M0
  • ARM Cortex-M3/M4/7
  • ARM Cortex-R4
  • ARM Cortex-A8/A9
  • ARM920T/ARM926 etc
  • MIPS32
  • x86
  • Andes
  • C-Sky
  • RISC-V
  • PowerPC

License

RT-Thread is Open Source software under the Apache License 2.0 since RT-Thread v3.1.1. License and copyright information can be found within the code.

/*
 * Copyright (c) 2006-2018, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 */

Since 9th of September 2018, PRs submitted by the community may be merged into the main line only after signing the Contributor License Agreement(CLA).

NOTE:

RT-Thread using the Apache license v2.0 is only launched after the release of v3.1.1, and is still in preparation right now.

Usage

RT-Thread RTOS uses scons as building system. Therefore, please install scons and Python 2.7 firstly. So far, the RT-Thread scons building system support the command line compile or generate some IDE's project. There are some option varaibles in the scons building script (rtconfig.py):

  • CROSS_TOOL the compiler which you want to use, gcc/keil/iar.
  • EXEC_PATH the path of compiler.

In SConstruct file:

RTT_ROOT This variable is the root directory of RT-Thread RTOS. If you build the porting in the bsp directory, you can use the default setting. Also, you can set the root directory in RTT_ROOT environment variable and not modify SConstruct files.

When you set these variables correctly, you can use command:

scons

under BSP directory to simplely compile RT-Thread RTOS.

If you want to generate the IDE's project file, you can use command:

scons --target=mdk/mdk4/mdk5/iar/cb -s

to generate the project file.

NOTE: RT-Thread scons building system will tailor the system according to your rtconfig.h configuration header file. For example, if you disable the lwIP in the rtconfig.h by commenting the #define RT_USING_LWIP, the generated project file should have no lwIP related files.

Contribution

Please refer the contributors in the github. Thank all of RT-Thread Developers.