diff options
| author | PProvost <[email protected]> | 2020-05-13 13:41:20 -0600 |
|---|---|---|
| committer | PProvost <[email protected]> | 2020-05-13 13:41:20 -0600 |
| commit | 2747d397f36303b6993d29353c466c55e0356489 (patch) | |
| tree | 3f61b8d9b6c9b74250580b466829ae564b9c3c46 | |
| parent | bfc20d5a29ded2d45d873dfbb3707c9791f68451 (diff) | |
Readme updates
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | docs/deps.png | bin | 0 -> 65876 bytes |
2 files changed, 11 insertions, 2 deletions
@@ -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 + +# 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. + + + # Building and using the library ## Prerequisites @@ -22,11 +29,11 @@ Install the following tools: $ 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()`. -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 $ 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 ``` +NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself. + # Repository Structure and Usage ## Branches & Releases diff --git a/docs/deps.png b/docs/deps.png Binary files differnew file mode 100644 index 00000000..e67db1b9 --- /dev/null +++ b/docs/deps.png |
