Skip to content

Commit e4f8eb1

Browse files
committed
Updated readme
1 parent 7ec9fc5 commit e4f8eb1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,3 +212,10 @@ Note: there is now an option to get Vietnam's braille standard as braille output
212212
* A preference setting to control the duration of pausing (works with changes to relative speech rate for math)
213213
* Support to recognize chemistry notation and speak it appropriately
214214
* Translations to Indonesian and Vietnamese
215+
216+
## Development Environment
217+
We include here a few important notes for setting up a development environment for working on this project.
218+
* The configuration in `.vscode/settings.json` assumes that a virtual environment has been set up in a directory named `.venv`.
219+
This virtual environment should have `pyright` and `ruff` installed, and should use Python 3.11 (32-bit).
220+
* The relative path `../NVDA/source` is included in the pyright configuration in `pyproject.toml` to enable typechecking functions from the main NVDA repository.
221+
For this to function as expected, the main NVDA repository (https://github.com/nvaccess/nvda) should be cloned into the same directory as this repository.

0 commit comments

Comments
 (0)