Embedded/threadx
1
0
Fork 0
mirror of https://github.com/azure-rtos/threadx synced 2025-01-30 08:02:57 +08:00
Code Issues Releases Wiki Activity

Readme updates

Browse Source
This commit is contained in:
PProvost 2020-05-13 13:41:20 -06:00
parent bfc20d5a29
commit 2747d397f3
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,6 +6,13 @@ This advanced real-time operating system (RTOS) is designed specifically for dee
Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/threadx Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/threadx
# Understanding inter-component dependencies
The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them--shown in the following graph--that are important to understand when setting up your builds.
![dependency graph](docs/deps.png)
# Building and using the library # Building and using the library
## Prerequisites ## Prerequisites
@ -22,11 +29,11 @@ Install the following tools:
$ git clone https://github.com/azure-rtos/threadx.git $ git clone https://github.com/azure-rtos/threadx.git
``` ```
## Building the threadx static library ## Building as a static library
Each component of Azure RTOS comes with a composible CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake command `add_subdirectory()`. Each component of Azure RTOS comes with a composible CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake command `add_subdirectory()`.
While the typical usage pattern is to include threadx into your device code source tree to be built & linked with your code, you can compile threadx as a standalone static library to confirm your build is set up correctly. While the typical usage pattern is to include threadx into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly.
```bash ```bash
$ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja . $ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja .
@ -34,6 +41,8 @@ $ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja .
$ cmake --build ./build $ cmake --build ./build
``` ```
NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself.
# Repository Structure and Usage # Repository Structure and Usage
## Branches & Releases ## Branches & Releases

BIN
docs/deps.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 64 KiB