search

AlexPerathoner / SlimHUD

Replacement for MacOS' volume, brightness and keyboard backlight HUDs.
https://alexperathoner.github.io/SlimHUD
GNU General Public License v3.0
388 stars 8 forks source link

Update readme #114

Open AlexPerathoner opened 1 year ago

AlexPerathoner commented 1 year ago
image

nice xd @kaydenanderson

AlexPerathoner commented 1 year ago

A couple of things:

  1. Please include the three screens of the settings window (https://github.com/AlexPerathoner/SlimHUD/tree/feature/settings-design). They look great, not including would be a shame
  2. You should use the format using the image in the Screens folder, not the url (e.g. https://user-images.githubusercontent.com/104660117/215941948-2b297736-2925-4964-8b26-795fdba21d56). You can merge feature/settings-design into repo/update-readme to get those screens in your branch, too
  3. Some tables are malformed, you can check them out here: https://github.com/AlexPerathoner/SlimHUD/tree/repo/update-readme
  4. I'm not sure about the font you used in the custom graphics: image

    Why not use SF Pro / Display (which is used in the app, too?

kaydenanderson commented 1 year ago

hey there @AlexPerathoner! sure thing! :) as for #4, that is actually SF Pro Display/medium, so i adjusted it to Semibold to make it more obvious - hope that works.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

AlexPerathoner commented 1 year ago

Actually the correct font to use should be the default used by GitHub for markdown styling @kaydenanderson that's why SF was standing out

AlexPerathoner commented 1 year ago

@kaydenanderson do you need help? xd image