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

improve project basic documentation #134

Open
ssbarnea opened this issue Oct 8, 2017 · 2 comments
Open

improve project basic documentation #134

ssbarnea opened this issue Oct 8, 2017 · 2 comments

Comments

@ssbarnea
Copy link

ssbarnea commented Oct 8, 2017

I am raising a bug regarding the lack of useful information in the main README file

  • License (also needs to be added to the repo)
  • if it needs privilege escalation (install time or when
  • does it needs disabling SIP (system integrity protection)
  • compatibility - no High Sierra mentions, no minimal version mentions
  • relatively recent build link
  • CLI install method: brew (cask) install instructions
  • status compatibility with VPNs as they would affect how DNS resolution works
  • similar projects section - really useful, maybe even some pros/cons mentioned, could help a lot. Example: Hosts.prefpane - abandoned, last change >5 years ago.

Maybe these would look as obvious information for the author, but for someone visiting the project the first time they are not and they are key in deciding if you want to try it or.

@OJFord
Copy link

OJFord commented Jan 19, 2018

And a screenshot! Or a longer description than:

Gas Mask is simple hosts file manager for Mac OS X. It allows editing of host files and switching between them.

Reading that I have no idea how it does that, though I read elsewhere that it's menu bar based.

@2ndalpha
Copy link
Owner

If someone is willing to help on this, I'm happy to merge the PR

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

No branches or pull requests

3 participants