Page 1 of 1

Sharing ESP-IDF vscode project

Posted: Thu Jul 29, 2021 1:34 pm
by JimNickerson
I wonder which files/folders in project I must share to send a project with someone else?
Along the same which files must I backup with git ?

Re: Sharing ESP-IDF vscode project

Posted: Fri Jul 30, 2021 8:13 am
by ESP_bignacio

Code: Select all

- myProject/
             - build/ 
                        ...
             - CMakeLists.txt
             - sdkconfig
             - components/ - component1/ - CMakeLists.txt
                                         - Kconfig
                                         - src1.c
                           - component2/ - CMakeLists.txt
                                         - Kconfig
                                         - src1.c
                                         - include/ - component2.h
             - main/ - CMakeLists.txt
                     - src1.c
                     - src2.c
             - .vscode/ - launch.json
                        - settings.json
                        - c_cpp_properties.json
This is the typical structure of your project source code. I think everything in the build and .vscode directory should be avoided and the rest should be shared. The vscode folder may have required settings such as idf.espIdfPath but doesn't make sense to share since they match your local setup IDF_PATH and would not work on others setup. Just make sure the other user has configured the extension like you have (same esp-idf version python and IDF tools for example).