From fdf1167e999a1536b104aa5682ae5a4eacef60da Mon Sep 17 00:00:00 2001 From: Mike Pennisi Date: Mon, 8 Apr 2024 20:03:36 -0400 Subject: [PATCH 1/2] Update installation instructions The maintainers do not actively publish an npm package at this time. Update the recommended usage instructions to accurately describe the supported technique for running the code. --- README.md | 8 ++++---- bin/at-driver | 0 2 files changed, 4 insertions(+), 4 deletions(-) mode change 100644 => 100755 bin/at-driver diff --git a/README.md b/README.md index 9b15738..470a5c2 100644 --- a/README.md +++ b/README.md @@ -28,19 +28,19 @@ which is required by the automation voice. ## Installation -1. Install the project by executing the following command: +1. Download the source code by executing the following command: - npm install -g @bocoup/windows-sapi-tts-engine-for-automation + git clone https://github.com/w3c/aria-at-automation-driver.git 2. Run the install command in a terminal: - at-driver install + ./bin/at-driver install If prompted for system administration permission, grant permission. 3. Start the server by executing the following command in a terminal: - at-driver serve + ./bin/at-driver serve The process will write a message to the standard error stream when the WebSocket server is listening for connections. The `--help` flag will cause diff --git a/bin/at-driver b/bin/at-driver old mode 100644 new mode 100755 From 71dde4fae90640f1a504b1fa58880a785e3550b6 Mon Sep 17 00:00:00 2001 From: Mike Pennisi Date: Mon, 8 Apr 2024 20:11:12 -0400 Subject: [PATCH 2/2] fixup! Update installation instructions --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 470a5c2..02e3ea8 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,18 @@ which is required by the automation voice. git clone https://github.com/w3c/aria-at-automation-driver.git -2. Run the install command in a terminal: +2. Install the Node.js dependencies (from inside the project directory): + + npm install + +3. Run the install command in a terminal (from inside the project directory): ./bin/at-driver install If prompted for system administration permission, grant permission. -3. Start the server by executing the following command in a terminal: +4. Start the server by executing the following command in a terminal (from + inside the project directory): ./bin/at-driver serve @@ -46,10 +51,10 @@ which is required by the automation voice. WebSocket server is listening for connections. The `--help` flag will cause the command to output advanced usage instructions (e.g. `at-driver --help`). -4. Configure any screen reader to use the synthesizer named "Microsoft Speech +5. Configure any screen reader to use the synthesizer named "Microsoft Speech API version 5" and the text-to-speech voice named "Bocoup Automation Voice." -5. Use any WebSocket client to connect to the server. The protocol is described +6. Use any WebSocket client to connect to the server. The protocol is described below. (The server will print protocol messages to its standard error stream for diagnostic purposes only. Neither the format nor the availability of this output is guaranteed, making it inappropriate for external use.)