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

Refine README structure: Add installation guide #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hayschan
Copy link

  1. Added filesremote into winget repo [Package Request]: FilesRemote microsoft/winget-pkgs#111639 (comment)
  2. Added installation instructions for:
    1. Debian
    2. Tar
    3. macOS
    4. Windows exe
    5. winget

@allanrbo
Copy link
Owner

allanrbo commented Jul 12, 2023

Hi Hays,

Thank you so much for your interest in my project here! This pull request is very kind of you! :-)

Unfortunately I think I better liked it the way I had it before, so I'm going to respectfully decline.

  • I liked that the animated gif is the first thing on the page, as I feel like it very quickly gives potential users a clear picture of what the app does, without having to read anything.
  • I liked that the screenshots for each platform were visible directly on the page, as it makes it clear, even without having to read anything or click anywhere, that there's a native look for each platform.
  • I like to keep readme's as concise as possible, and I'm thinking perhaps the detailed installation instructions aren't necessary here. The kind of person who knows that what an "SSH file manager" is, and that they need one, I think is also the kind of person that easily knows how to drag-and-drop an app from a .dmg file, or extract a zip or tarball. So I'm a bit worried that these detailed instructions may be a distraction more than a benefit.
  • The ```shell change on the command line usage makes Github do syntax-highlighting on words like "for", which in this case were part of the instruction message, and not a programming keyword.
  • It's the first time I'm hearing of winget. It looks very cool! I've used chocolatey in the past, and this looks similar. I see that the package was committed to winget's repo just yesterday by @mdanish-kh - is this someone you are working with? While it was very kind of @mdanish-kh to create this package with my name, I don't think I can guarantee that I'll get around to keeping the winget-pkgs repo up to date going forward, and to test it, as I am not myself a winget user. For this reason I am hesitant to recommend it here from the official repo of FilesRemote. But I'm super happy if @mdanish-kh plans to keep the winget package up to date there and tests it there.

Again, I am very thankful that you took the time to make this PR otherwise! I'm sorry it was just a bit incompatible with my taste for how I like the readme to be in this pet project that is very dear to me :-) I hope you are OK with this.

@mdanish-kh
Copy link

It's the first time I'm hearing of winget. It looks very cool! I've used chocolatey in the past, and this looks similar. I see that the package was committed to winget's repo just yesterday by @mdanish-kh - is this someone you are working with? While it was very kind of @mdanish-kh to create this package with my name, I don't think I can guarantee that I'll get around to keeping the winget-pkgs repo up to date going forward, and to test it, as I am not myself a winget user. For this reason I am hesitant to recommend it here from the official repo of FilesRemote. But I'm super happy if @mdanish-kh plans to keep the winget package up to date there and tests it there.

Hi @allanrbo thanks for the ping! I'm just a community contributor over at the winget-pkgs repo and this package was requested by the community so I added the manifest for the package. Just as an FYI, I'll add a bit of context if you don't mind.

Typically updates are handled by community contributors / users of the package that update the package themselves or create issues over at winget-pkgs repo for update requests. There is some automation set up in the winget-pkgs repo that checks for hash mismatches / 404 URLs / updating packages with vanity URLs but it doesn't support updating these kind of packages. The ideal scenario is that the publishers take hold of updating the packages as part of their release process. We have tools like winget-create (maintained by the WinGet team) and other community-developed tools like WinGet-Releaser (maintained by @vedantmgoyal2009) that you can add as a GitHub Action here in the repo that can automate submissions to the winget repository on every new release. I'm not trying to be pushy but if you ever plan on taking control of the package, you can take a look at these tools. I'm sure the community would be glad to help you get set up too if you face any obstacles! Thanks :)

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.

3 participants