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

docs: Improve Linux cmake getting started documentation (IDFGH-1020) #3347

Closed
wants to merge 1 commit into from

Conversation

Roosted7
Copy link
Contributor

Whilst I was going through the new cmake getting started guide, I think I encountered two minor imperfections in the documentation.

Python2 usage

Firstly, if the default python command defaults to version 3 instead of 2, the guide recommends to run idf.py with the older python2 interpreter. But the the way it was suggested will not work, since the idf.py script can not be passed as an argument to the python2 interpreter but its path must then be used.
In this commit, I used a nested which command to find the path.

Discrepancy pip usage

In step 4 of the getting the started, pip is used to install the requirements.txt file. In the Ubuntu/Debian prerequisite package list pip is included, but in the Arch version it is not. It seems to make sense to add it to the Arch package list as well. (Even though imho it would make more sense to remove step 4 and do not use pip to install the packages again for a specific user)

@CLAassistant
Copy link

CLAassistant commented Apr 22, 2019

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot changed the title docs: Improve Linux cmake getting started documentation docs: Improve Linux cmake getting started documentation (IDFGH-1020) Apr 22, 2019
@igrr igrr closed this in 1c56e33 Jun 4, 2019
trombik pushed a commit to trombik/esp-idf that referenced this pull request Aug 9, 2019
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

Successfully merging this pull request may close these issues.

2 participants