Skip to content

docs: Add Ubuntu quickstart and troubleshooting sections#150

Open
klederson wants to merge 1 commit intoideasman42:mainfrom
klederson:docs/ubuntu-quickstart-troubleshooting
Open

docs: Add Ubuntu quickstart and troubleshooting sections#150
klederson wants to merge 1 commit intoideasman42:mainfrom
klederson:docs/ubuntu-quickstart-troubleshooting

Conversation

@klederson
Copy link

  • Add Ubuntu Quickstart section with step-by-step installation guide
  • Document system dependencies (pulseaudio-utils, xdotool)
  • Provide solutions for PEP 668 externally-managed-environment error
  • Add troubleshooting section for common Ubuntu-specific errors
  • Include Wayland compatibility notes

Tested on Ubuntu 24.10. These additions help new users avoid common installation pitfalls and get nerd-dictation running quickly.

- Add Ubuntu Quickstart section with step-by-step installation guide
- Document system dependencies (pulseaudio-utils, xdotool)
- Provide solutions for PEP 668 externally-managed-environment error
- Add troubleshooting section for common Ubuntu-specific errors
- Include Wayland compatibility notes

Tested on Ubuntu 24.10. These additions help new users avoid common
installation pitfalls and get nerd-dictation running quickly.
Copy link
Owner

@ideasman42 ideasman42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information seems useful but is overly spesific for the main readme:

Please split these into two separate documents:

  • readme-ubuntu-24-10.rst
  • readme-troubleshooting.rst

They can be linked from the main page.

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

Successfully merging this pull request may close these issues.

2 participants