make the template readme separate from the addons readme - #52
Open
makhlwf wants to merge 4 commits into
Open
Conversation
…Docs and symlinked it using mklink README.md templateDocs\README.md
…uldn't be any to copy so the user has to create it with his content
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In this PR, I have created an
addonsTemplatefolder that contains theREADME.mdfrom the main template repo. Then, I used the commandmklink README.md templateDocs\README.mdto make it a symlink so GitHub fetches it when someone opens the repo homepage. I also encouraged the user to create their own README in the root of the repo instead of telling them to copy it. See the conversation at #50 for full context.