mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
e357b63448
# Objective - `README.md` is a common file that usually gives an overview of the folder it is in. - When on <https://crates.io>, `README.md` is rendered as the main description. - Many crates in this repository are lacking `README.md` files, which makes it more difficult to understand their purpose. <img width="1552" alt="image" src="https://github.com/bevyengine/bevy/assets/59022059/78ebf91d-b0c4-4b18-9874-365d6310640f"> - There are also a few inconsistencies with `README.md` files that this PR and its follow-ups intend to fix. ## Solution - Create a `README.md` file for all crates that do not have one. - This file only contains the title of the crate (underscores removed, proper capitalization, acronyms expanded) and the <https://shields.io> badges. - Remove the `readme` field in `Cargo.toml` for `bevy` and `bevy_reflect`. - This field is redundant because [Cargo automatically detects `README.md` files](https://doc.rust-lang.org/cargo/reference/manifest.html#the-readme-field). The field is only there if you name it something else, like `INFO.md`. - Fix capitalization of `bevy_utils`'s `README.md`. - It was originally `Readme.md`, which is inconsistent with the rest of the project. - I created two commits renaming it to `README.md`, because Git appears to be case-insensitive. - Expand acronyms in title of `bevy_ptr` and `bevy_utils`. - In the commit where I created all the new `README.md` files, I preferred using expanded acronyms in the titles. (E.g. "Bevy Developer Tools" instead of "Bevy Dev Tools".) - This commit changes the title of existing `README.md` files to follow the same scheme. - I do not feel strongly about this change, please comment if you disagree and I can revert it. - Add <https://shields.io> badges to `bevy_time` and `bevy_transform`, which are the only crates currently lacking them. --- ## Changelog - Added `README.md` files to all crates missing it.
62 lines
1.8 KiB
TOML
62 lines
1.8 KiB
TOML
[package]
|
|
name = "bevy_reflect"
|
|
version = "0.14.0-dev"
|
|
edition = "2021"
|
|
description = "Dynamically interact with rust types"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["bevy"]
|
|
|
|
[features]
|
|
default = ["smallvec"]
|
|
# When enabled, provides Bevy-related reflection implementations
|
|
bevy = ["smallvec", "bevy_math", "smol_str"]
|
|
glam = ["dep:glam"]
|
|
bevy_math = ["glam", "dep:bevy_math"]
|
|
petgraph = ["dep:petgraph"]
|
|
smallvec = ["dep:smallvec"]
|
|
uuid = ["dep:uuid"]
|
|
# When enabled, allows documentation comments to be accessed via reflection
|
|
documentation = ["bevy_reflect_derive/documentation"]
|
|
|
|
[dependencies]
|
|
# bevy
|
|
bevy_math = { path = "../bevy_math", version = "0.14.0-dev", features = [
|
|
"serialize",
|
|
], optional = true }
|
|
bevy_reflect_derive = { path = "bevy_reflect_derive", version = "0.14.0-dev" }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.14.0-dev" }
|
|
bevy_ptr = { path = "../bevy_ptr", version = "0.14.0-dev" }
|
|
|
|
# other
|
|
erased-serde = "0.4"
|
|
downcast-rs = "1.2"
|
|
thiserror = "1.0"
|
|
serde = "1"
|
|
smallvec = { version = "1.11", optional = true }
|
|
|
|
glam = { version = "0.27", features = ["serde"], optional = true }
|
|
petgraph = { version = "0.6", features = ["serde-1"], optional = true }
|
|
smol_str = { version = "0.2.0", optional = true }
|
|
uuid = { version = "1.0", optional = true, features = ["v4", "serde"] }
|
|
|
|
[dev-dependencies]
|
|
ron = "0.8.0"
|
|
rmp-serde = "1.1"
|
|
bincode = "1.3"
|
|
serde_json = "1.0"
|
|
serde = { version = "1", features = ["derive"] }
|
|
static_assertions = "1.1.0"
|
|
|
|
[[example]]
|
|
name = "reflect_docs"
|
|
path = "examples/reflect_docs.rs"
|
|
required-features = ["documentation"]
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
|
all-features = true
|