Skip to content

Commit

Permalink
Major rewrite of the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke Davis authored and Luke Davis committed Jul 14, 2023
1 parent a070aef commit e4df5ad
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,44 @@

This is an [NVDA][1] add-on, designed to collect the name and version numbers of any software the user runs.
This process is completely passive to the user.
As long as the add-on is enabled, it will collect version info.

A list of all installed NVDA add-ons is also collected.
As long as the add-on is enabled, it will collect (remember) the name, version, and bitness (64 or 32) for every piece of software on your system which receives NVDA focus.
A list of all installed NVDA add-ons is also collected at startup.

Currently, each time you restart NVDA, the collected data is lost.
A file-backed listing is intended for a future version.

### Controls
### Reports

The add-on can produce two reports.
The reports capture the remembered list of apps and information as of the time you request the report, even if you aren't still running those apps.

#### The HTML report:

To view a tabular list of applications and add-ons which Version Collector has encountered, press `NVDA+ctrl+shift+v`.
You may change this key mapping under the **Tools** category of NVDA's Input Gestures dialog--search for "Version Collector".
You can exit the report view by pressing escape.

You can browse the version report like a webpage, with two tables.
Each table starts with a heading describing its contents.
The first table is applications which have been the focused window while the add-on was running.
The second table is the list of NVDA add-ons.
You may select any or all of these items using normal Windows or NVDA commands, and copy them to the clipboard.
You can exit the report view by pressing escape.
You may select part or all of these items using normal Windows or NVDA commands, and copy them to the clipboard.

Note, however, that because of the way copying from NVDA's browse mode works, the tabular formatting will be lost if you copy from this window.
The HTML report is intended mainly for your own reading.
The text report is preferable for copying.

As an alternative to viewing the report, if your objective is to copy the entire list of detected versions to the clipboard, you may instead press the `NVDA+shift+ctrl+v` key sequence twice rapidly.
#### The text report:

As an alternative to viewing the HTML report, if your objective is to copy the entire list of detected versions to the clipboard, you may instead press the `NVDA+shift+ctrl+v` key sequence twice rapidly.
In this case, a text formatted report will be copied directly to the clipboard without ever opening the report viewer.

The columns in the table are separated by tabs, and formatting is preserved as much as possible.

### Special notes

* In order to collect your NVDA version, you may simply open the NVDA menu (`NVDA+n`). This is enough to include your NVDA version in the list of captured versions. A future release will collect your NVDA version without needing to do this.
* In order to collect your Windows version, open any Windows application (Explorer, desktop, etc.), and reference the version column that appears in the report. The Windows version will be directly collected in a future version.
* In order to collect your Windows version, open any Windows application (Explorer, desktop, etc.), and reference the version column that appears in the report. The Windows version will be directly collected in a future release.

Please make feature requests by email or [GitHub issue][2].
As always, I am happy to hear from users of my add-ons, even just to say how you found the add-on useful.
Expand Down

0 comments on commit e4df5ad

Please sign in to comment.