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

Update README.md #3148

Merged
merged 6 commits into from Apr 13, 2023
Merged

Update README.md #3148

merged 6 commits into from Apr 13, 2023

Conversation

mdanish-kh
Copy link
Contributor

@mdanish-kh mdanish-kh commented Apr 12, 2023

Description of the changes

The commit messages describe each change but I'll provide further description for few of the changes:

Build Instructions:
image

Windows 10 SDK, version 2004 is required to build AppInstallerCLIPackage which is not installed via the workloads mentioned in the instructions. For me, on Visual Studio 2022 17.4.4, the workloads install Windows SDK for Windows 11 and I had to manually install the older version.

P.S.: I could not figure out how to debug the winget-cli codebase (yes i'm a newbie with Visual Studio). I did get it to build and deploy, and successfully run wingetdev, but I'm not sure how to debug the code. If the reviewers can suggest changes for the debug instructions / update the guide themselves, it would be much appreciated!


Microsoft Reviewers: Open in CodeFlow

@mdanish-kh mdanish-kh requested a review from a team as a code owner April 12, 2023 22:11
@denelon
Copy link
Contributor

denelon commented Apr 13, 2023

@Trenly, you went through some of this as well. Do you have anything to add here?

README.md Outdated Show resolved Hide resolved
@Trenly
Copy link
Contributor

Trenly commented Apr 13, 2023

@Trenly, you went through some of this as well. Do you have anything to add here?

Nothing to add; I might suggest specific documentation on how to run the Unit Tests, but thats a separate PR.

@mdanish-kh
Copy link
Contributor Author

The project also depends on .NET Core 3.1 Runtime, but the Visual Studio/Visual Studio Installer will take care of it by prompting the user after loading the solution.

I decided not to include it in the README in case the project gets updated to target a new version (3.1 is EOL anyways). Let me know though, if this is something that still should be documented and I'll update it in the PR.

@mdanish-kh mdanish-kh marked this pull request as ready for review April 13, 2023 17:24
@denelon denelon merged commit d8ff3ae into microsoft:master Apr 13, 2023
4 checks passed
@mdanish-kh mdanish-kh deleted the update-readme branch April 13, 2023 20:08
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.

None yet

3 participants