Skip to content

Commit

Permalink
readme: Instructions to use this project as component, clone repo in …
Browse files Browse the repository at this point in the history
…components directory instead of externals
  • Loading branch information
C47D committed Mar 18, 2020
1 parent 4aa4ec1 commit daa3818
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,10 @@ https://github.com/littlevgl/lv_port_esp32.git`

It is recommended to install this repo as a submodule in your IDF project's git repo. The configuration system has been designed so that you do not need to copy or edit any files in this repo. By keeping your submodule directory clean you can ensure reproducible builds and easy updates from this upstream repository.

From your project root:
From your project root (you can get the esp32 idf project template [here](https://github.com/espressif/esp-idf-template)):

1. `mkdir -p externals`
2. `git submodule add https://github.com/littlevgl/lv_port_esp32.git
externals/lv_port_esp32`
1. `mkdir -p components`
2. `git submodule add https://github.com/littlevgl/lv_port_esp32.git components/lv_port_esp32`
3. `git submodule update --init --recursive`
4. Edit your CMake or Makefile to add this repo's components folder to the IDF components path.

Expand Down

0 comments on commit daa3818

Please sign in to comment.