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

Add ReadMe.txt for packages #308

Merged
merged 14 commits into from
Mar 7, 2022
Merged

Conversation

bijington
Copy link
Contributor

Description of Change

Adds a README.txt to the NuGet Package that provide guidance to consumers on how to Use the toolkit upon installation.

Linked Issues

PR Checklist

Additional information

@bijington
Copy link
Contributor Author

bijington commented Feb 24, 2022

Also need to update the ReadMe.md file to include the getting started info as per:

#273 (comment)

@bijington
Copy link
Contributor Author

bijington commented Feb 24, 2022

Also need to apply this to Maui.Markup -> CommunityToolkit/Maui.Markup#27

@bijington
Copy link
Contributor Author

bijington commented Feb 24, 2022

Final point is to test the behaviour when adding CommunityToolkit.Maui package to see if it opens 2 readme.txt files This works as expected (only showing the package added directly)

@bijington bijington marked this pull request as ready for review February 28, 2022 09:53
Copy link
Collaborator

@brminnick brminnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Shaun!

Just a couple tweaks recommended 👍

src/CommunityToolkit.Maui.Core/readme.txt Show resolved Hide resolved
src/CommunityToolkit.Maui/ReadMe.txt Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@brminnick brminnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Shaun! I had a thought about the namespace for the UseCommunityToolkit and UseCommunityToolkitCore extension methods.

Let me know what you think!

README.md Outdated Show resolved Hide resolved
src/CommunityToolkit.Maui/ReadMe.txt Outdated Show resolved Hide resolved
@bijington bijington mentioned this pull request Mar 7, 2022
10 tasks
bijington and others added 6 commits March 7, 2022 19:39
Co-authored-by: Brandon Minnick <13558917+brminnick@users.noreply.github.com>
Co-authored-by: Brandon Minnick <13558917+brminnick@users.noreply.github.com>
Co-authored-by: Brandon Minnick <13558917+brminnick@users.noreply.github.com>
Copy link
Collaborator

@brminnick brminnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Shaun!!

@brminnick brminnick merged commit c026899 into main Mar 7, 2022
@delete-merged-branch delete-merged-branch bot deleted the feature/273-readme-txt-in-package branch March 7, 2022 20:35
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.

[Proposal] Ship ReadMe.txt file with packages to inform consumers of necessary steps
3 participants