ArcadeRenegade / SidebarDiagnostics

A simple sidebar for Windows desktop that displays hardware diagnostic information.
GNU General Public License v3.0
2.3k stars 201 forks source link

Mention winget installation method on README and/or Release Notes? #445

Open gsweats opened 7 months ago

gsweats commented 7 months ago

1. Is this a feature request?

No, it is a documentation recommendation to mention winget install ArcadeRenegade.SidebarDiagnostics on the README.md around where it points people to Install by going to the Releases page.

This issue could likely stop there, but I have found myself feeling creative (🌿) and the below short story, a "User Story" if you will, spilled out. So have a laugh I hope. I did.

Maybe I'll fork this and update it myself, but if I don't within a month, I probably forgot, and you are welcome to hit me up in any way you possibly can! Stalk me, baby!

A "User Story"...

...about Greg the Power User who wishes README mentioned winget install ...

As a "Power User", and "Linux Admin", Greg likes to install things using package managers.

Greg likes this for a variety of reasons, primarily speed of install via CLI typing vs Web UI clicking, not having to track down multiple download pages, fairly consistent bandwidth for quick downloads, and being able to export/backup packages that have been installed, removed, etc. for easy setup of a new computer (or by Greg accidentally wiping out his C:\ again, while trying to mess around with Linux partitioning on a six-disk beast.

Greg was lazy and didn't do a choco search SidebarDiagnostics or winget search SidebarDiagnostics before ever-so-blindly following the [README.md] and downloading the .msi from the wonderful Releases page.

But alas! All hope was not lost. Greg just installed some other thing with choco, and another with winget, his terminal was still open!

While the .msi downloaded, Greg quickly ran choco search SidebarDiagnostics to no-avail, and then winget search sidebardiagnostics to find ArcadeRenegade.SidebarDiagnostics listed as a package!

Typing as fast as possible, trying to beat the icky .msi download, Greg smashed out winget install sidebardiagnostics and was met with failure...no packages found! Were all our hero's dreams being dashed?

Fear not, after realizing that SidebarDiagnostics was not specific enough for winget, our hero effed around with -e and -i flags, until finally, when weakened and about to give up, he saw ArcadeRenegade as the GitHub Organization, it reminded him of the Montreal band Arcade Fire, which our hero loves, and says it was the best live show of his life, and he has seen many, many live shows, and several amazing ones. Reinvegorated by psychedelic alt-rock music, Greg types winget install ArcadeRenegade.SidebarDiagnostics, smashes [ENTER], and smiles as he sees it install, even though the .msi was just finishing so he couldn't cancel it and still had to delete the dirty-little-file afterwards.

Our hero has still not tried the application, but felt it was worthy of his time to submit an Issue to this wonderful open-source project, and to try and bump his public GitHub cred since he works on closed source classified projects during the day in GitLab that don't help his GitHub cred, or mastery of GitHub workflow, or staying up to date with contemporary open-source project best-practices.

5. Reproduction

  1. Learn about SidebarDiagnostics from https://alternativeto.net/software/hwinfo32/ (too complicated, tried several times over a couple years).
  2. Click to go to https://github.com/ArcadeRenegade/SidebarDiagnostics
  3. Glance at README.md (since it is rendered in the project's default view)
  4. See "Download" link immediately (wonderful positioning)
  5. Go to Releases page to Download .msi or .exe
  6. Download .msi
  7. Shake my head and say "wtf man" and hit [WIN]+[X], then tap [A] to open an Admin Terminal, and then type choco search SidebarDiagnostics and receive 0 results.
  8. No problem, fallback to winget.
    1. winget search SidebarDiagnostics
    2. One result, appears, screenshot at end of description.
    3. Result had ArcadeRenegade in the id, matched with github.com/ArcadeRenegade/SidebarDiagnostics (thank you for keeping consistent)
    4. winget install sidebardiagnostics => FAIL => No package found matching input criteria.
    5. winget install ArcadeRenegade.SidebarDiagnostics => SUCCESS

6. Terminal Capture

PS C:\Users\gs> choco search sidebardiagnostics
Chocolatey v2.2.2
0 packages found.
PS C:\Users\gs> winget search sidebardiagnostics
Name                Id                                Version Source
---------------------------------------------------------------------
Sidebar Diagnostics ArcadeRenegade.SidebarDiagnostics 3.6.3   winget
PS C:\Users\gs> winget install sidebardiagnostics
No package found matching input criteria.
PS C:\Users\gs> winget install sidebardiagnostics -i
No package found matching input criteria.
PS C:\Users\gs> winget install sidebardiagnostics -e
No package found matching input criteria.
PS C:\Users\gs> winget install SidebarDiagnostics -e
No package found matching input criteria.
PS C:\Users\gs> winget install ArcadeRenegade.SidebarDiagnostics
Found Sidebar Diagnostics [ArcadeRenegade.SidebarDiagnostics] Version 3.6.3
This application is licensed to you by its owner.
Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
Downloading https://github.com/ArcadeRenegade/SidebarDiagnostics/releases/download/v3.6.3/Setup.exe
  ██████████████████████████████  3.67 MB / 3.67 MB
Successfully verified installer hash
Starting package install...
Successfully installed

7. For the Laughs

shaq-cat-shake-perfectness-q3e87zR


Peace ✌️ and Thanks 🙏!