4
4
http://www.nvda-project.org/
7
The NVDA source depends on several other packages to run correctly, as described below. All directories mentioned are relative to the root of the NVDA source distribution/checkout. Please create any directories mentioned that don't already exist.
7
The NVDA source depends on several other packages to run correctly, as described below. All directories mentioned are relative to the root of the NVDA source distribution. Please create any directories mentioned that don't already exist.
9
If you are running a 64 bit version of Windows, you should install the 32 bit versions of any dependencies that provide both 32 bit and 64 bit versions.
9
If you are running a 64 bit version of Windows, you should install the 32 bit versions of any dependencies that provide both 32 bit and 64 bit versions unless otherwise specified.
11
11
General dependencies:
12
* Python 2.6, version 2.6.4 or later: http://www.python.org/
12
* Python 2.7, version 2.7.0 or later: http://www.python.org/
13
13
* comtypes, version 0.6.2 or later: http://www.sourceforge.net/projects/comtypes/
14
* wxPython unicode (for Python 2.6), version 2.8.9.1 or later: http://www.wxpython.org/
15
* Python Windows Extensions (for Python 2.6), build 212 or later: http://www.sourceforge.net/projects/pywin32/
16
* eSpeak, version 1.43.03 or later, Windows dll:
14
* wxPython 2.8 unicode (for Python 2.7), version 2.8.11.0 or later: http://www.wxpython.org/
15
* Python Windows Extensions (for Python 2.7), build 214 or later: http://www.sourceforge.net/projects/pywin32/
16
* eSpeak, version 1.45.46 or later:
17
17
* Official web site: http://espeak.sourceforge.net/
18
* The Windows dll is tricky to build, so a pre-built version has been provided for convenience at http://www.nvda-project.org/3rdParty/
19
* Copy espeak.dll and espeak-data into the source\synthDrivers directory.
20
* Additional variants for eSpeak: http://www.nvda-project.org/espeak-variants/
21
* Extract the archive into the source\synthDrivers directory.
22
* IAccessible2, version 1.1.0.0 or later:
23
* The proxy dll and typelib are required.
24
* Pre-built versions have been provided for convenience at http://www.nvda-project.org/3rdParty/
25
* Copy ia2.tlb into the source\typelibs directory.
26
* Copy the 32 bit version of the proxy dll into the source\lib directory, naming it IAccessible2Proxy.dll.
27
* Copy the 64 bit version of the proxy dll into the source\lib64 directory, naming it IAccessible2Proxy.dll.
18
* Download the espeak source archive. Note that it must be an official source archive from the espeak website containing already compiled phoneme data, not straight from svn.
19
* Extract it in to include/espeak so that include/espeak/src, include/espeak/dictsource, include/espeak/platforms and include/espeak/espeak-data all exist.
20
* IAccessible2, version 1.2.1 or later: http://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2
21
* Download the merged IDL and copy it to include\ia2\ia2.idl.
28
22
* ConfigObj, version 4.6.0 or later:
29
23
* Web site: http://www.voidspace.org.uk/python/configobj.html
30
* Copy configobj.py and validate.py into the source directory.
31
* liblouis, version 1.8.0 or later, Windows dll and Python bindings:
24
* Copy configobj.py and validate.py into the global Python site-packages directory.
25
* liblouis, version 2.3.0 or later, Windows dll and Python bindings:
32
26
* Official web site: http://code.google.com/p/liblouis/
33
27
* A pre-built version has been provided for convenience at http://www.nvda-project.org/3rdParty/
34
28
* Copy the louis Python package directory into the source directory.
38
32
* NVDA media (images and sounds): http://www.nvda-project.org/nvda-media/
39
33
* Extract the archive into the root of your NVDA source distribution.
40
34
* System dlls not present on many systems: mfc90.dll, msvcp90.dll, msvcr90.dll, Microsoft.VC90.CRT.manifest:
41
* IF you don't have them already, all of these files have been bundled for convenience at http://www.nvda-project.org/3rdParty/system-dlls.7z
35
* If you don't have them already, all of these files have been bundled for convenience at http://www.nvda-project.org/3rdParty/system-dlls.7z
42
36
* Copy them either into the source directory or into your Windows system32 directory.
44
* You can build this yourself. You need to have the Windows SDK installed, which is quite large. See source\nvdaHelper\building.txt for instructions.
45
* Alternatively, pre-built versions are provided alongside NVDA snapshots for convenience. See http://www.nvda-project.org/snapshots/
46
* Extract this archive into the root of your NVDA source distribution.
47
* Adobe AcrobatAccess interface typelib:
48
* You can build this yourself using midl from the idl located at http://www.adobe.com/devnet/acrobat/downloads/ClientFiles.zip
49
* Alternatively, a pre-built version has been provided for convenience at http://www.nvda-project.org/3rdParty/AcrobatAccess.tlb
50
* Copy AcrobatAccess.tlb into the source\typelibs directory.
37
* Adobe Acrobat accessibility interface, version 9.1 or later:
38
* This can be found in the client files archive available from http://www.adobe.com/devnet/acrobat/interapplication_communication.html
39
* The archive is named something like Acrobat_Accessibility_9.1.zip.
40
* Extract the AcrobatAccess.idl file into include\AcrobatAccess.
51
41
* Adobe FlashAccessibility interface typelib: http://www.nvda-project.org/3rdParty/FlashAccessibility.tlb
42
* Copy FlashAccessibility.tlb into the source\typelibs directory.
52
43
* txt2tags, version 2.5 or later: http://txt2tags.sourceforge.net/
53
* Copy the txt2tags Python script to the source directory or the global Python site-packages directory, naming it txt2tags.py.
44
* Copy the txt2tags Python script to the global Python site-packages directory, naming it txt2tags.py.
45
* Microsoft Windows SDK, version 7.0: http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en
46
* You need to install both the 32 bit and 64 bit libraries and tools.
47
* MinHook, version 1.1.0 or later: http://www.codeproject.com/KB/winsdk/LibMinHook.aspx
48
*Download the source archive. The file name is something like MinHook_110_src.zip depending on exact version.
49
* You will need an account on CodeProject to download from there.
50
* extract the libMinHook directory from the source archive into the NVDA include directory.
51
* Boost C++ Libraries, version 1.42 or later:
52
* You can download the latest Windows installer from http://www.boostpro.com/download
53
* On the components page of the installer, make sure to install at least all of the defaults (whatever is already checked).
54
* NVDA only uses the Boost headers; none of the pre-compiled libraries are necessary.
55
* SCons, version 2.0.0 or later: http://www.scons.org/
56
* As the scons command (scons.bat) is installed in to the scripts directory inside the directory where you installed Python, it is necessary to add the scripts directory to your path variable so that you can run scons from anywhere. The rest of this readme assumes that scons can be run in this way.
55
58
To use the brltty braille display driver:
56
* brlapi Python bindings, version 0.5.3 or later, distributed with BRLTTY for Windows, version 4.0-2 or later:
59
* brlapi Python bindings (for Python 2.7), version 0.5.5 or later, distributed with BRLTTY for Windows, version 4.2-2 or later:
57
60
* You can download BRLTTY for Windows at http://brl.thefreecat.org/brltty/
58
61
* The brlapi Python bindings can be found in the BRLTTY installation directory and are named brlapi-x.y.z.exe
60
To use the Alva BC640/680 braille display driver:
61
* ALVA BC6 generic dll, version 2.0.3.0 or later: http://www.nvda-project.org/3rdParty/alvaw32.dll
63
To use the ALVA BC640/680 braille display driver:
64
* ALVA BC6 generic dll, version 3.0.4.1 or later: http://www.nvda-project.org/3rdParty/alvaw32.dll
62
65
* Copy alvaw32.dll into the source\brailleDisplayDrivers directory.
67
To use the MDV Lilli braille display driver:
68
* lilli.dll, version 2.1.0.0: http://www.nvda-project.org/3rdParty/lilli.dll
69
* Copy lilli.dll into the source\brailleDisplayDrivers directory.
71
To use the Handy Tech braille display driver:
72
* Handy Tech Braille SDK, version 1.3.0.2 or later: https://www.handytech.de/en/normal/service/downloads/ht-software/brailledriver/
73
* Copy these files from the SDK's prog directory into NVDA's source\brailleDisplayDrivers\handyTech directory: HtBrailleDriverServer.dll, HtBrailleDriverServer.tlb, sbsupport.dll, dealers.dat
74
* If you want to be able to use this driver when running from source code, you will need to install the Handy Tech universal driver: ftp://ftp.handytech.de/public/Software/BrailleDriver/bsd1206a.exe
76
To use the Baum braille display driver:
77
* pyserial (for Python 2.x), version 2.5 or later: http://pypi.python.org/pypi/pyserial
64
79
To build a binary version of NVDA:
65
* Py2Exe (for Python 2.6), version 0.6.9 or later: http://www.sourceforge.net/projects/py2exe/
80
* Py2Exe (for Python 2.7), version 0.6.9 or later: http://www.sourceforge.net/projects/py2exe/
82
To build a portable archive:
83
* 7-Zip: http://www.7-zip.org/
67
85
To build an installer:
68
86
* Nulsoft Install System, version 2.42 or later: http://nsis.sourceforge.net/
69
* NSIS UAC plug-in, version 0.0.11d or later: http://nsis.sourceforge.net/UAC_plug-in
87
* NSIS UAC plug-in, version 0.0.11d:
88
* Official web site: http://nsis.sourceforge.net/UAC_plug-in
89
* NVDA does not work with recent versions. Direct link to 0.0.11d: http://stashbox.org/560965/UAC%20v0.0.11d.zip
70
90
* Copy the ANSI build of UAC.dll (found in release\a in the archive) into the installer directory.
92
To generate developer documentation:
93
* Doxygen Windows installer (1.7.3 or above): http://www.stack.nl/~dimitri/doxygen/download.html
72
95
== Preparing the Source Tree ==
73
Before you can run the NVDA source code, you must run generate.py located in the source directory.
74
You should do this again whenever the version of comtypes changes or new language files are added.
96
Before you can run the NVDA source code, you must prepare the source tree.
97
You do this by opening a command prompt, changing to the root of the NVDA source distribution and typing:
99
You should do this again whenever the version of comtypes changes or language files are added or changed.
101
=== Compiling NVDAHelper with Debugging Options ===
102
Among other things, preparing the source tree builds the NVDAHelper libraries.
103
If trying to debug nvdaHelper, You can control various debugging options with the nvdaHelperDebugFlags command line variable. It takes one or more of the following flags:
104
* symbols: debugging symbols will be added to the DLLs and pdb files will be generated for use with a debugger. (symbols are produced by default, but if specifying nvdaHelperDebugFlags and you want symbols it is still necessary to specify this keyword.)
105
* debugCRT: the libraries will be linked against the debug C runtime and assertions will be enabled. (By default, the normal CRT is used and assertions are disabled.)
106
* noOptimize: All compiler optimizations will be disabled. (Optimization 2 [/O2] is used by default.)
107
* RTC: runtime checks (stack corruption, uninitialized variables, etc.) will be enabled. (The default is no runtime checks.)
108
The special keywords none and all can also be used in place of the individual flags.
110
An example follows that enables symbols and disables optimizations:
111
scons source nvdaHelperDebugflags=symbols,noOptimize
76
113
== Running the Source Code ==
77
114
To start NVDA from source code, run nvda.pyw located in the source directory.
79
== Building a Standalone Binary Version of NVDA ==
80
You can use py2exe to make a binary build of NVDA which can be run on a system without Python and all of NVDA's other dependencies installed (as we do for snapshots and releases).
82
Assuming py2exe is installed, open a command prompt, change to the NVDA source directory and type:
85
== Building an NVDA Installer ==
86
To build an NVDA installer:
87
1. First build a standalone binary version as described in the previous section.
88
2. Using Windows Explorer, locate nvda.nsi in the installer directory.
89
3. Press the applications key and choose "Compile NSIS Script".
90
The installer will be built and placed in the installer directory.
117
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).
119
Binary archives and bundles can be created using scons from the root of the NVDA source distribution. To build any of the following, open a command prompt and change to this directory.
121
To make a non-archived binary build (equivalent to an extracted portable archive), type:
123
The build will be created in the dist directory.
125
To create a portable archive, type:
127
The archive will be placed in the output directory.
129
To build an installer, type:
131
The installer will be placed in the output directory.
133
To generate developer documentation, type:
135
The developer docs will be placed in the devDocs folder in the output directory.
137
To generate an archive of debug symbols for the various dll/exe binaries, type:
139
The archive will be placed in the output directory.
141
Optionally, the build can be customised by providing variables on the command line:
142
* version: The version of this build.
143
* release: Whether this is a release version.
144
* publisher: The publisher of this build.
145
* certFile: The certificate file with which to sign executables. The certificate must be in pfx format and contain the private key.
146
* certPassword: The password for the private key in the signing certificate. If omitted, no password will be assumed.
147
* certTimestampServer: The URL of the timestamping server to use to timestamp authenticode signatures. If omitted, signatures will not be timestamped.
148
* outputDir: The directory where the final built archives and such will be placed.
149
* targetArchitectures: The target architectures that NVDA should support. Possible values are all, x86 and x86_64. This should generally be left as the default.
151
For example, to build an installer with a specific version, you might type:
152
scons installer version=test1
added
removed
readme.txt
