Skip to content
This repository has been archived by the owner on Mar 10, 2021. It is now read-only.

Improve docs #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Amazon FreeRTOS Examples

This repo shows how to set up a CMake project for ESP32 and use amazon freertos as an external library.
This repo shows how to set up a CMake project for ESP32 and use amazon Freertos as an external library.

See the official document for software prerequisite, https://docs.aws.amazon.com/freertos/latest/userguide/getting_started_espressif.html

Expand All @@ -13,7 +13,7 @@ cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=freertos/tools/cmake/toolchains/xtens
To flash,

```sh
cmake --build build --target flash
CMake --build --target flash
```

To monitor the output,
Expand All @@ -27,7 +27,7 @@ amazon-freertos/vendors/espressif/esp-idf/tools/idf.py monitor

### Linker Error: undefined reference to <some_function>

If you changed some configuartion and run into this, usually it's because of missing dependent libraries/demos. To fix it, first find out which CMake target the missing functions belong to, normally it should be in the `CMakeLists.txt` closest to the source file where the functions are defined. Then add the CMake target to your application dependency list using the `target_link_libraries` command in the root level `CMakeLists.txt`. For example,
If you changed some configuration and run into this, usually it's because of missing dependent libraries/demos. To fix it, first, find out which CMake target the missing functions belong to, normally it should be in the `CMakeLists.txt` closest to the source file where the functions are defined. Then add the CMake target to your application dependency list using the `target_link_libraries` command in the root level `CMakeLists.txt`. For example,

1. Linker complains about `undefined reference to NumericComparisonInit`.
1. `NumericComparisonInit` is defined in `amazon-freertos/demos/ble/iot_ble_numericComparison.c`.
Expand Down