Skip to content

Commit

Permalink
Update readme and workfolow
Browse files Browse the repository at this point in the history
  • Loading branch information
mzanm committed Jul 5, 2023
1 parent a6de9ea commit 157831c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/workflows/build_addon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ jobs:
python -m pip install --upgrade pip setuptools wheel
pip install scons markdown
sudo apt-get update -y
sudo apt-get full-upgrade -y
sudo apt-get install -y gettext
- name: Build add-on
run: scons
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ The NVDA Autoclip add-on automatically reads out the contents of the clipboard w

Installation is the same to all other add-ons.

1. Download the latest release from the [releases page](https://github.com/mzanm/nvda-autoclip/releases).
1. Download the latest release from the [releases page](https://github.com/mzanm/NVDAAutoclip/releases).
2. Click on the download file while NVDA is running and the install add-on dialog should appear.

## Usage

Once the add-on is installed and enable via either the shortcut or the option in the tools menu, it will automatically read out the contents of the clipboard whenever it changes. Note that currently that the add-on is activated temporarily until next restart of NVDA. The add-on doesn't save it's state in the configuration of NVDA:
Once the add-on is installed and enable via either the shortcut or the option in the tools menu, it will automatically read out the contents of the clipboard whenever it changes. Note that by default the add-on is activated temporarily until the next restart of NVDA. The add-on doesn't save it's state in the configuration of NVDA unless you change that behavior in the settings panel of the add-on:

- **Keyboard shortcut**: Press `NVDA+Control+Shift+K` to toggle automatic clipboard reading. The shortcut can be reassigned in the NVDA input gestures dialog normally like all other gestures.
- **Tools menu**: Open the NVDA tools menu and select "`Automatic clipboard reading`" to toggle it on or off.
Expand All @@ -20,4 +20,6 @@ By default, The add-on will not interrupt before speaking the clipboard. If you

## Configuration

The add-on right now has one configuration option in the settings panel, which allows the user to configure whether the add-on should always interrupt current speech to speak the clipboard.
The add-on has the following configuration options in the settings panel:
- allows the user to configure whether the add-on should always interrupt current speech to speak the clipboard.
- Allows the user to configure whether the add-on should remember it's states, if it's enabled or disabled. This option must be enabled to be able to setup the add-on to run in in a specific program using configuration profiles.

0 comments on commit 157831c

Please sign in to comment.