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.

Sign up for GitHub

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

Jump to bottom

Readme: Updated the "Running the Source Code" section to make it clea… #11160

Merged
merged 1 commit into from
May 15, 2020
Merged

Readme: Updated the "Running the Source Code" section to make it clea… #11160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,16 @@ By default, builds also do not use any compiler optimizations.
Please see the `release` keyword argument for what compiler optimizations it will enable.

## Running the Source Code
To start NVDA from source code, run `nvda.pyw` located in the source directory.
Most developers run directly from source by:
```
cd source
pythonw.exe nvda.pyw
```
Note: Since NVDA is a Windows application (rather than command line), it is best to run it with `pythonw.exe`.
However, if during development you encounter an error early in the startup of NVDA, you can use `python.exe` which is likely to give more information about the error.

To view help on the arguments that NVDA will accept, use the `-h` or `--help` option.
These arguments are also documented in the user guide.
Since NVDA is a Windows application (rather than command line), it is best to run it with `pythonw.exe`.
However, if during development you encounter an error early in the startup of NVDA, you can use `python.exe` which is likely to give more information about the error.

## Building NVDA
A binary build of NVDA can be run on a system without Python and all of NVDA's other dependencies installed (as we do for snapshots and releases).
Expand Down