Skip to content

Update readme with component directory path (CA-70) #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
damienpontifex wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme with component directory path (CA-70) #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,25 @@ $ git clone --recursive https://github.com/espressif/esp-azure.git
```

> Note that if you ever change the branch or the git head of either esp-idf or esp-azure, ensure that all the submodules of the git repo are in sync by executing `git submodule update --init --recursive`
- Add path to components in your project CMakeLists
```CMake
set(EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS} <other-folder-of-clone>/esp-azure/port)
```

or use CMake [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) to add the components to your project. Modify your project level CMakeLists.txt to look similar to:

```CMake
cmake_minimum_required(VERSION 3.11)
include(FetchContent)
FetchContent_Declare(
espazure
GIT_REPOSITORY https://github.com/espressif/esp-azure.git
)
FetchContent_MakeAvailable(espazure)
set(EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS} ${espazure_SOURCE_DIR}/components)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(my-esp-project)
```

##

Expand Down