docs: game example README --> "Get Started" doc #124
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
|
Should probably relate this back to the Issue that spawned it, eh? |
RothAndrew
suggested changes
Oct 26, 2021
|
@btlghrants is going to add a bit more to prerequisites, and add a bit more inline docs to the After those additions, LGTM |
|
/test all |
RothAndrew
approved these changes
Oct 26, 2021
jeff-mccoy
pushed a commit
that referenced
this pull request
Feb 8, 2022
* docs: convert game example README to "Get Started" doc & link from main README Signed-off-by: Jeff McCoy <[email protected]>
Noxsios
pushed a commit
that referenced
this pull request
Mar 8, 2023
* docs: convert game example README to "Get Started" doc & link from main README Signed-off-by: Jeff McCoy <[email protected]>
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.
Overhaul of the examples/game README. Now linked via "Get Started" link on project front page.
This makes the example write-up much more explicit & hand-hold-y as it is now positioned to be the "first contact" with a new / prospective user. Other examples won't / shouldn't have to be as explicit as this one.
Includes new script-based asciinema recording with timestamp-linked entry points positioned within each of the README sections.