Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Merged by Bors] - README/examples: better direct users to the release version #1624

Closed
wants to merge 2 commits into from
Closed

[Merged by Bors] - README/examples: better direct users to the release version #1624

wants to merge 2 commits into from

Conversation

inodentry
Copy link
Contributor

@inodentry inodentry commented Mar 11, 2021 •
edited
Loading

  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.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Mar 11, 2021
@inodentry inodentry mentioned this pull request Mar 11, 2021
Merged
@cart
Copy link
Member

cart commented Mar 12, 2021

Good calls all around!

@cart
Copy link
Member

cart commented Mar 12, 2021

bors r+

bors bot pushed a commit that referenced this pull request Mar 12, 2021
@inodentry
README/examples: better direct users to the release version (#1624)
8e3532e 
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.
@bors
Copy link
Contributor

bors bot commented Mar 12, 2021

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title README/examples: better direct users to the release version [Merged by Bors] - README/examples: better direct users to the release version Mar 12, 2021
@bors bors bot closed this Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@inodentry @cart @alice-i-cecile