docs: add Getting Started sections to root and project READMEs #63#65
Open
SakshiTamshetti wants to merge 1 commit intoPTCInc:mainfrom
Open
docs: add Getting Started sections to root and project READMEs #63#65SakshiTamshetti wants to merge 1 commit intoPTCInc:mainfrom
SakshiTamshetti wants to merge 1 commit intoPTCInc:mainfrom
Conversation
Author
|
Hi @rlabbeptc , As discussed in the issue, I've added Getting Started sections to:
Each section adds only what was confirmed missing:
No existing content was removed or changed. |
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
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.
Summary
Added "Getting Started" sections to the root README and all three project READMEs.
What was missing
The existing READMEs describe the high-level purpose well, but a developer
picking up this repo for the first time had no clear path from "I cloned it"
to "it ran." Specifically, there were no:
dotnet restore,dotnet build, ordotnet runcommandsWhat this PR adds
README.mdKepware.Api/README.mdKepwareSync.Service/README.mdKepware.Api.Sample/README.mdWhat was NOT changed
Checklist