Help users discover the correct version of the official examples #109
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
memoryruins
suggested changes
Mar 11, 2021
memoryruins
reviewed
Mar 11, 2021
| @@ -8,8 +8,8 @@ page_template = "book-section.html" | |||
|
|
|||
| You have reached the end of The Bevy Book! And unfortunately, we haven't even scratched the surface of Bevy's features! Eventually this book will cover almost every facet of Bevy, but until then we recommend checking out: | |||
|
|
|||
| * **[The Bevy Examples](https://github.com/bevyengine/bevy/tree/main/examples#examples)**: We create an example for every major Bevy feature. This is currently the best way to learn Bevy's features and how to use them. | |||
| * **[Breakout](https://github.com/bevyengine/bevy/blob/main/examples/game/breakout.rs)**: A small "breakout" clone that illustrates what a real Bevy game looks like. | |||
| * **[The Bevy Examples](https://github.com/bevyengine/bevy/tree/latest/examples#examples)**: We create an example for every major Bevy feature. This is currently the best way to learn Bevy's features and how to use them. | |||
There was a problem hiding this comment.
This link continues to use #examples at the end, so if #109 (comment) decides to not use #examples, perhaps this should be aligned with the other links.
bors bot
pushed a commit
to bevyengine/bevy
that referenced
this pull request
Mar 12, 2021
1. The instructions in the main README used to point users to the git main version. This has likely misdirected and confused many new users. Update to direct users to the latest release instead. 2. Rewrite the notice in the examples README to make it clearer and more concise, and to show the `latest` git branch. See also: bevyengine/bevy-website#109 for similar changes to the website and official book.
Co-authored-by: memoryruins <memoryruinsmusic@gmail.com>
Co-authored-by: memoryruins <memoryruinsmusic@gmail.com>
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.
latestbranch (which is the release version, notmain)git checkoutthe correct version when they clone the repo to run the examplesLearnpage linking to the examples