JakubAndrysek / PySpaceMouse

🎮 Multiplatform Python library for 3Dconnexion SpaceMouse devices using raw HID.
https://spacemouse.kubaandrysek.cz/
MIT License
65 stars 17 forks source link

fix typo & udev rules command in README #31

Open rickwierenga opened 6 days ago

rickwierenga commented 6 days ago

with echo .. | sudo tee writing is a sudo operation. input redirection uses the user's permission, which might not be sufficient. this change allows easier copy paste

Summary by Sourcery

Documentation:

sourcery-ai[bot] commented 6 days ago

Reviewer's Guide by Sourcery

This PR fixes documentation issues in the README.md file, specifically addressing a command syntax issue for setting up udev rules and correcting a typo. The main change improves the reliability of the udev rules setup command by using the tee approach instead of direct redirection with sudo.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the udev rules setup command to use tee instead of direct redirection
  • Changed command syntax from 'sudo echo ... > file' to 'echo ...
sudo tee file'
  • Removed redundant alternative section since it now matches the main command
  • README.md
    Fixed a typo in the documentation
    • Corrected spelling of 'Aleternative' to 'Alternative'
    README.md

    Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
    rickwierenga commented 6 days ago

    sorry, just saw that that is what is in the collapsable. why not make that the default?

    rickwierenga commented 6 days ago

    it might also be nice to add

    sudo udevadm control --reload-rules
    sudo udevadm trigger