Skip to content

Commit 2747d39

Browse files
committed
Readme updates
1 parent bfc20d5 commit 2747d39

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ This advanced real-time operating system (RTOS) is designed specifically for dee
66

77
Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/threadx
88

9+
10+
# Understanding inter-component dependencies
11+
12+
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.
13+
14+
![dependency graph](docs/deps.png)
15+
916
# Building and using the library
1017

1118
## Prerequisites
@@ -22,18 +29,20 @@ Install the following tools:
2229
$ git clone https://github.com/azure-rtos/threadx.git
2330
```
2431

25-
## Building the threadx static library
32+
## Building as a static library
2633

2734
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()`.
2835

29-
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.
36+
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.
3037

3138
```bash
3239
$ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja .
3340

3441
$ cmake --build ./build
3542
```
3643

44+
NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself.
45+
3746
# Repository Structure and Usage
3847

3948
## Branches & Releases

docs/deps.png

64.3 KB
Loading

0 commit comments

Comments
 (0)