feat(docs): add quick installer and shortcut setup to README #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a recommended Quick Install section with automated installer command and detailed menu of installable components. Document installer aviour: architecture, installation path (~/.local/bin), CUDA/cuDNN GPU detection, systemd user service setup, creation of stt group, and directory/log/socket setup. Expand and centralize keyboard shortcut instructions: add COSMIC automatic setup notes, commands to run when building from source (just install-daemon / just setup-cosmic-shortcut), manual COSMIC steps, and platform-specific examples for GNOME and KDE. Clarify the default command used by shortcuts (stt record --write) and how conflicts are detected. Adjust "Building from Source" and usage snippets: include daemon systemd start/enable/status commands and a note on viewing logs. Tweak install suggestions in the quick-start to highlight daemon options (CUDA/cuDNN) and where to run the cosmic shortcut helper. These changes improve onboarding and make installation and shortcut setup clearer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a recommended Quick Install section with automated installer
command and detailed menu of installable components. Document installer
aviour: architecture, installation path (~/.local/bin),
CUDA/cuDNN GPU detection, systemd user service setup, creation of
stt group, and directory/log/socket setup.
Expand and centralize keyboard shortcut instructions: add COSMIC
automatic setup notes, commands to run when building from source
(just install-daemon / just setup-cosmic-shortcut), manual COSMIC
steps, and platform-specific examples for GNOME and KDE. Clarify the
default command used by shortcuts (stt record --write) and how conflicts
are detected.
Adjust "Building from Source" and usage snippets: include daemon
systemd start/enable/status commands and a note on viewing logs. Tweak
install suggestions in the quick-start to highlight daemon options
(CUDA/cuDNN) and where to run the cosmic shortcut helper. These changes
improve onboarding and make installation and shortcut setup clearer.