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

docs: Description of --urls needs clarification #347

Open
mloskot opened this issue Dec 12, 2023 · 3 comments
Open

docs: Description of --urls needs clarification #347

mloskot opened this issue Dec 12, 2023 · 3 comments

Comments

@mloskot
Copy link

mloskot commented Dec 12, 2023

I'm a frequent contributor to winget packages. I've used YamlCreate.ps1 and wingetcreate. I'm now switching to the Komac as apparently more user-friendly and with streamlined experience for updating existing packages.

The first thing that I noticed while reading the README.md is that the description of the --urls parameter is incomplete and to me it raises more questions than answers. The examples presented do not really help: what are these https://www.firstUrl.com,https://www.secondUrl.com, website, website + support space, download installer 1 and download installer 2?

Would it be possible to make the description of the --urls parameter no-brainer really?

@russellbanks
Copy link
Owner

Sure, thanks for letting me know about this. I'll be merging the version 2 of Komac (rust rewrite) into this repository soon. The URLs parameter for that mimics wingetcreate more in that you can delimit them by a space. I'll improve the documentation along with this.

@mloskot
Copy link
Author

mloskot commented Dec 12, 2023

Thanks for the answer!
I have just poked around this way, and learned it by doing :)

image

So, I've got my first winget manifest updated with Komac - great tool!

It would be quite handy to fill the PR with the checklist similarly as the YamlCreate.ps1 does it, especially for those new to winget as there are instructions how to validate and test, for example

@russellbanks
Copy link
Owner

It would be quite handy to fill the PR with the checklist similarly as the YamlCreate.ps1 does it, especially for those new to winget as there are instructions how to validate and test, for example

The reason the body doesn't get filled with the checkboxes is because Komac is able to do all the validation itself. Komac won't ever create a manifest that doesn't match the schema for winget manifests. This means that if there were checkboxes, they would be filled in every time making them a bit useless to moderators.

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

No branches or pull requests

2 participants