summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPProvost <[email protected]>2020-05-13 13:41:14 -0600
committerPProvost <[email protected]>2020-05-13 13:41:14 -0600
commite4af35665b08e1edb95807431eb9ff2ff935d939 (patch)
tree94ae79cee759f5327b8f4a48d42bf58bf0996508
parenta1427e03718d03c04eee61f2ae00ea07c484897a (diff)
Readme updates
-rwxr-xr-xREADME.md12
-rw-r--r--docs/deps.pngbin0 -> 65876 bytes
2 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 01738d38..305f90ef 100755
--- a/README.md
+++ b/README.md
@@ -6,6 +6,12 @@ This advanced, industrial-grade TCP/IP network stack is designed specifically fo
Documentation for this library can be found here: http://docs.microsoft.com/azure/rtos/netxduo
+# 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
## Prerequisites
@@ -22,11 +28,11 @@ Install the following tools:
$ git clone https://github.com/azure-rtos/netxduo.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 +40,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
new file mode 100644
index 00000000..e67db1b9
--- /dev/null
+++ b/docs/deps.png
Binary files differ