Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NPM install documentation to top-level README #14

Open
ChrisC opened this issue Oct 30, 2024 · 0 comments
Open

Add NPM install documentation to top-level README #14

ChrisC opened this issue Oct 30, 2024 · 0 comments

Comments

@ChrisC
Copy link
Contributor

ChrisC commented Oct 30, 2024

It would be a lot easier for users to install this software if we directed them to the npm package and also provided install instructions both on the NPM package page and on the top-level README in this repo.

Additionally, the basic install instructions may require some additional OS configuration to get the AT-driver-server running. For example, suggestions for the MACOS server install instructions could be:

  • run npm -g install @bocoup/macos-at-driver-server
  • run at-driver install
  • Go into VoiceOver Utility and uncheck Web -> General -> "Automatically speak the webpage"
  • Allow JavaScript from Apple Events' in the Developer section of Safari Settings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant