-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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.
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
add an option about display server protocol, and create document docs/cargo_features.md
#249
Conversation
LGTM, can't test it right now |
@@ -1,7 +1,10 @@ | |||
# Examples | |||
|
|||
These examples demonstrate the main features of Bevy and how to use them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I would prefer to leave non-default feature documentation out of the README. Instead, lets create a new docs/features.md
file and link to it from the readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cart Done! I create a new docs/features.md
file and link to it from the readme.
The suggestions in examples/README.md
is reversed for I think it's useful for people who are not familiar with cargo.
How do you like it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Just one small set of changes: lets rename the file cargo_features.md
, make the title # Cargo Features
and then in the main readme make it ## [Bevy Cargo Features](docs/cargo_features.md)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
docs/features.md
docs/features.md
docs/cargo_features.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I'm going to learn the normay way to resolve merge conflicts. Stay tuned.
Merge conflicts resolved! I'm looking into the check fails... |
The build break is my fault! This should be good to go. I'll do some validation myself. |
…s/cargo_features.md` (bevyengine#249) add an option about display server protocol, and create document `docs/cargo_features.md`
add an option
--features wayland
orfeatures x11