Skip to content
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.

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

Documentation request #40

Open
jmporter34 opened this issue Apr 1, 2022 · 2 comments
Open

Documentation request #40

jmporter34 opened this issue Apr 1, 2022 · 2 comments

Comments

@jmporter34
Copy link

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
Copy link
Collaborator

georgik commented Apr 21, 2022

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
Copy link
Author

jmporter34 commented Apr 21, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants