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

README.md: Clarify Python Configuration #806

Closed
mnatsuhara opened this issue May 7, 2020 · 4 comments
Closed

README.md: Clarify Python Configuration #806

mnatsuhara opened this issue May 7, 2020 · 4 comments
Labels
documentation Related to documentation or comments

Comments

@mnatsuhara
Copy link
Contributor

mnatsuhara commented May 7, 2020

In How To Run The Tests With A Native Tools Command Prompt, step 3 says

Acquire Python 3.8 or newer.

However, the configuring step (step 10 in How To Build With A Native Tools Command Prompt) which says

Invoke cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE={where your vcpkg clone is located}\scripts\buildsystems\vcpkg.cmake -S . -B {wherever you want binaries} to configure the project. For example, cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=C:\Dev\vcpkg\scripts\buildsystems\vcpkg.cmake -S . -B out\build\x64

appears several paragraphs above the instructions of how to run tests. If Python 3.8 is not already installed when the configuration step is completed, it is likely that the user will need to reconfigure in order for CMake to be able to find the correct Python executable. It would be good to mention that possibility following the "Acquire Python..." step.

@mnatsuhara mnatsuhara added the documentation Related to documentation or comments label May 7, 2020
@cbezault
Copy link
Contributor

cbezault commented May 7, 2020

Would it be sufficient to hard fail in the configure step if you don't have a new enough version of Python?

@mnatsuhara
Copy link
Contributor Author

That seems like a viable option. In that case, I think we should also update step 1 of How To Build With A Native Tools Command Prompt to include installing Python 3.8 along with CMake, Ninja, and VS 2019.

@AlexGuteniev
Copy link
Contributor

Is #2103 enough?

@mnatsuhara
Copy link
Contributor Author

Yes, I think moving up that mention of Python in the README addresses this. I'm closing this issue -- thanks for following up here!

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

No branches or pull requests

4 participants