Skip to content

Commit ed7a955

Browse files
committed
Readme updates
1 parent 8b4f317 commit ed7a955

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Azure RTOS GUIX Studio is available on the Microsoft Download Center.
1010

1111
Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/guix
1212

13+
# Understanding inter-component dependencies
14+
15+
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.
16+
17+
![dependency graph](docs/deps.png)
18+
19+
1320
# Building and using the library
1421

1522
## Prerequisites
@@ -26,18 +33,20 @@ Install the following tools:
2633
$ git clone https://github.com/azure-rtos/guix.git
2734
```
2835

29-
## Building the threadx static library
36+
## Building as a static library
3037

3138
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()`.
3239

33-
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.
40+
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.
3441

3542
```bash
3643
$ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja .
3744

3845
$ cmake --build ./build
3946
```
4047

48+
NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself.
49+
4150
# Repository Structure and Usage
4251

4352
## Branches & Releases

docs/deps.png

64.3 KB
Loading

0 commit comments

Comments
 (0)