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

README Examples Addition #39

Closed
trollLemon opened this issue Aug 7, 2023 · 3 comments · Fixed by #46
Closed

README Examples Addition #39

trollLemon opened this issue Aug 7, 2023 · 3 comments · Fixed by #46
Labels
documentation Improvements or additions to documentation

Comments

@trollLemon
Copy link
Contributor

Hello,

Before I begin, I want to say great work on SwayOSD. I found this project a few days ago, and it is a nice addition to my Sway setup.

I want suggest adding this software's custom value usage to the README.

Currently, the README shows examples such as:

 bindsym XF86MonBrightnessUp exec swayosd --brightness raise
 bindsym XF86AudioRaiseVolume exec swayosd --output-volume raise

I know that passing in '--help' tells how to use the custom amounts for the change of brightness and volume. However, there is an example of using max volume with a value within the README:

exec swayosd --max-volume 120

So I think there should be examples of using custom values for all the brightness and volume within the README. I am willing to do a pr adding to the README file. Before I begin, I am wondering if I should have a sub-section for the Sway examples with something like:

# Brightness raise custom value
bindsym XF86MonBrightnessUp + <key> exec swayosd --brightness 10
# Brightness lower custom value
bindsym XF86MonBrightnessDown + <key> exec swayosd --brightness -10
# Volume raise custom value
bindsym XF86AudioRaiseVolume + <key> exec swayosd --output-volume 10
# Volume raise custom value
bindsym XF86AudioRaiseVolume + <key> exec swayosd --output-volume -10

Or should it be somewhere else?

@ErikReider ErikReider added the documentation Improvements or additions to documentation label Aug 7, 2023
@ErikReider
Copy link
Owner

ErikReider commented Aug 7, 2023

A PR would be great! :)

I'll be changing some of the commands/executables to make it more user friendly soon so I'd wait until that's done. I can ping you if you want when it's done

@trollLemon
Copy link
Contributor Author

If you could ping me once you are done that would be great.

@ErikReider
Copy link
Owner

@trollLemon #45 is merged :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants