(CAT-434) Update README.md #568
Merged
Conversation
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
gavindidrichsen
previously approved these changes
Mar 7, 2024
nabertrand
reviewed
Mar 7, 2024
Previous to this commit, our PDK-template documentation would be fairly intimadating and confusing, often jumpin from basic introductions to advanced concepts, while expecting the reader to have an understanding of concepts they may not be familiar with. This commit aims to rework the README to ensure that its more readable and user-friendly.
LukasAud
force-pushed
the
CAT-434-Update_readme
branch
from
a0b0fd9 to
2abb361
Compare
nabertrand
reviewed
Mar 7, 2024
|
|
||
| ## Basic Usage | ||
|
|
||
| Templates like this one can be used in conjunction with the PDK. As default the PDK itself uses the templates within this repository to render files for use within a module. Templates can be passed to the PDK as a flag for several of the commands. | ||
| By default PDK uses the templates within this repository to render files for use within a module. To use a third-party template, pass its URL using the `–-template-url` flag as shown in the following example: |
There was a problem hiding this comment.
Should we note that the PDK will look for a branch called main unless specified? The error provided if that branch doesn't exist isn't clear that the branch couldn't be found, e.g.
pdk (FATAL): Unable to find a valid template at https://github.com/org/repo.git#main
There was a problem hiding this comment.
I feel like it should be expected that the command would default to main. But I guess a wee note won't hurt. Specially if there is people out there still using master in their naming conventions.
LukasAud
force-pushed
the
CAT-434-Update_readme
branch
from
2abb361 to
7d2255a
Compare
jordanbreen28
approved these changes
Mar 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previous to this commit, our PDK-template documentation would be fairly intimadating and confusing, often jumpin from basic introductions to advanced concepts, while expecting the reader to have an understanding of concepts they may not be familiar with.
This commit aims to rework the README to ensure that its more readable and user-friendly.