You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As a follow up to the recent PRs improving the build tool plugin and adding the command plugin, this PR incorporates several improvements to the README throughout. For example, some out dated information has been removed, sections have been reordered to improve organization, the video introduction was moved towards the top and some screenshots have been replaced with code to enable copy and paste. Information within Installation and Setup was de-mixed and moved to their appropriate sections. Headings and formatting have been tidied up throughout the document. Lastly, consistent line wrapping to 80 columns was applied to match the bulk of the existing text.
Hey @SimplyDanny, I realize this is a large diff but @tinder-cfuller and I were inspired to give the README some love after contributing the plugin work. We felt that the plugin info improvements would be helpful for the community when adopting the plugins. Once we got started, we decided to look at the Installation and Setup info more holistically. We hope you like how it turned out. Thank you.
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this! Really great ⭐
I am suggesting that some of the important notes become regular notes since a) there are too many that are important and b) not having an important note immediately following each header will improve readability.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As a follow up to the recent PRs improving the build tool plugin and adding the command plugin, this PR incorporates several improvements to the README throughout. For example, some out dated information has been removed, sections have been reordered to improve organization, the video introduction was moved towards the top and some screenshots have been replaced with code to enable copy and paste. Information within Installation and Setup was de-mixed and moved to their appropriate sections. Headings and formatting have been tidied up throughout the document. Lastly, consistent line wrapping to 80 columns was applied to match the bulk of the existing text.