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 macos ear damage warning #220

Merged
merged 1 commit into from
Aug 9, 2020
Merged

add macos ear damage warning #220

merged 1 commit into from
Aug 9, 2020

Conversation

elgiano
Copy link
Contributor

@elgiano elgiano commented Jul 23, 2020

After a request from users on the forum, here is a proposal for adding a warning for ear damage under macos downoad page, with recommendation to install the SafetyNet quark, and a link to Quarks installation instructions.

Forum discussion: https://scsynth.org/t/way-to-limit-maximum-output-volume
Issue with CoreAudio not clipping/limit the output range: supercollider/supercollider#4894

After a request from users on the forum, here is a proposal for adding a warning for ear damage under macos downoad page, with recommendation to install the SafetyNet quark, and a link to Quarks installation instructions.
@dyfer
Copy link
Member

dyfer commented Jul 24, 2020

I support adding this warning.

I'm not sure what's the best way to go about the quark though - installing a quark is a potentially complicated task (if git is not present; we don't handle that situation well currently, see supercollider/supercollider#3967, supercollider/supercollider#4283 and possibly other issues). I don't know if we have an alternative, but maybe others have ideas about this?

@elgiano
Copy link
Contributor Author

elgiano commented Jul 24, 2020

Maybe we can ask @adcxyz to add some installation instructions to his README?
Something like:

If you have git: Quarks.install("SafetyNet")
If you don't have git: 
- Download a ZIP from this page
- Extract to a folder
- Quarks.install("~/Downloads/SafetyNet")

@fghibellini
Copy link

I think it would be beginner friendlier to simply list git as a requirement (on osx it's an easy installation + there's plenty of tutorials) and describe how to install the quark through the GUI. e.g.:

1. install git
2. in the UI's top menu go to `Language > Quarks`, find the `SafetyNet` quark and click on the plus symbol. This should install the SafetyNet quark.

Copy link
Contributor

@mossheim mossheim left a comment

Choose a reason for hiding this comment

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

the most important thing is to have the warning and instructions out there; people can ask for more help if necessary, and we can also update the Using Quarks guide to indicate the git dependency.

thanks for this @elgiano !

@mossheim mossheim merged commit 7da54a8 into master Aug 9, 2020
@mossheim mossheim deleted the elgiano-patch-1 branch August 9, 2020 01:13
@adcxyz
Copy link

adcxyz commented Aug 9, 2020

Hi, added instructions as suggested:
https://github.com/adcxyz/SafetyNet/blob/master/README.md

@elgiano
Copy link
Contributor Author

elgiano commented Aug 9, 2020

Great @adcxyz, thanks!

You just have some little formatting things there, if you would like to make it look better:

  • need a space between ## and How to install, otherwise the heading doesnt render
  • you could enclose sclang commands in backticks to render them as code boxes

@mossheim
Copy link
Contributor

mossheim commented Aug 9, 2020

thanks @adcxyz !

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.

5 participants