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: Updated the "Running the Source Code" section to make it clea… #11160

Conversation

ShubhamJain7
Copy link
Contributor

Link to issue number:

None

Summary of the issue:

The "Running From Source" section of the Readme was a bit unclear as it didn't mention the exact commands needed to run the source code.

Description of how this pull request fixes the issue:

The "Running From Source" section of the Readme now mentions the commands for running from source and the reason for using pythonw.exe is now a note that immediately follows the commands.

Testing performed:

None

Known issues with pull request:

None

Change log entry:

not necessary

@josephsl
Copy link
Collaborator

josephsl commented May 13, 2020 via email

@ShubhamJain7
Copy link
Contributor Author

Is this better?

Note: Use pythonw.exe if you are looking to run the program as a GUI. However, if you want to look at errors early in the startup of NVDA in PowerShell, Command Prompt and such, use python.exe instead.

@josephsl
Copy link
Collaborator

josephsl commented May 14, 2020 via email

@lukaszgo1
Copy link
Contributor

@josephsl wrote;

Note that there is a more convenient way: py/pyw.

It is more convenient only if you have one version of Python installed. If not py/pyw defaults to the most recently installed which is not always what we want. It is also easier to run pythonw.exe from the specific path in case of multiple versions installed rather than fiddle with pyw parameters to specify version.

@josephsl
Copy link
Collaborator

josephsl commented May 14, 2020 via email

@ShubhamJain7
Copy link
Contributor Author

I think it is up to the developer to choose the version and python executable to use. Adding the details for the same in the readme seem unnecessary.
Thanks!

Copy link
Collaborator

@josephsl josephsl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, thanks for clarifying this for new developers.

Copy link
Contributor

@feerrenrut feerrenrut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ShubhamJain7 🎉

@feerrenrut feerrenrut merged commit cfd6949 into nvaccess:master May 15, 2020
@nvaccessAuto nvaccessAuto added this to the 2020.2 milestone May 15, 2020
@ShubhamJain7 ShubhamJain7 deleted the runningFromSourceClarificationInReadme branch May 15, 2020 07:59
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.

None yet

5 participants