search

espressif / idf-env

idf-env tool helps set up and manage ESP-IDF installations
29 stars 4 forks source link

Documentation request #40

Open jmporter34 opened 2 years ago

jmporter34 commented 2 years ago

Hi, Could someone please add a bit more information to the readme.md ? Specifically, when I type: idf-env config get --property python --idf-path %IDF_PATH%\ where exactly is idf-env getting the requested property information from ? Thanks

georgik commented 2 years ago

Thank you very much for the request @jmporter34 . idf-env was evolving in order to replace platform dependent functionality of idf-installer. It's good idea to provide explanation and documentation of idf-env features.

Quick answer to your question is that idf-env is searching for esp_idf.json in directory specified by environment variable: IDF_TOOLS_PATH or in directory ~/.espressif.

You can open the configuration file by command idf-env config edit or retrieve whole configuration by idf-env config get.

The python property points to virtualenv python which is specific for IDF. That's the reason why IDF_PATH is required as parameter. Different versions of ESP-IDF uses different dependencies they are stored in separate virtualenv.

jmporter34 commented 2 years ago

Thanks!

On Thu, Apr 21, 2022 at 8:52 AM Juraj Michálek @.***> wrote:

Thank you very much for the request @jmporter34 https://github.com/jmporter34 . idf-env was evolving in order to replace platform dependent functionality of idf-installer https://github.com/espressif/idf-installer. It's good idea to provide explanation and documentation of idf-env features.

Quick answer to your question is that the tools is searching for esp_idf.json in directory specified by environment variable: IDF_TOOLS_PATH or in directory ~/.espressif.

You can open the configuration file by command idf-env config edit or retrieve whole configuration by idf-env config get.

The python property points to virtualenv python which is specific for IDF. That's the reason why IDF_PATH is required as parameter. Different versions of ESP-IDF uses different dependencies they are stored in separate virtualenv.

— Reply to this email directly, view it on GitHub https://github.com/espressif/idf-env/issues/40#issuecomment-1105169679, or unsubscribe https://github.com/notifications/unsubscribe-auth/AIWSL53ZHT2PZWAZFR57YWDVGFFQRANCNFSM5SITK2SQ . You are receiving this because you were mentioned.Message ID: @.***>