Add readme to errors crate and clean up cargo files (#3125)

# Objective

- Document that the error codes will be rendered on the bevy website (see bevyengine/bevy-website#216)
- Some Cargo.toml files did not include the license or a description field

## Solution

- Readme for the errors crate
- Mark internal/development crates with `publish = false`
- Add missing license/descriptions to some crates

- [x] merge bevyengine/bevy-website#216
This commit is contained in:
Niklas Eicker 2021-11-13 23:06:48 +00:00
parent d0f423d653
commit 94db0176fe
7 changed files with 22 additions and 9 deletions

View file

@ -2,10 +2,13 @@
name = "benches" name = "benches"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
description = "Benchmarks for Bevy engine"
publish = false
license = "MIT OR Apache-2.0"
[dev-dependencies] [dev-dependencies]
criterion = "0.3" criterion = "0.3"
bevy = { path = "../" } bevy = { path = ".." }
[[bench]] [[bench]]
name = "system_stage" name = "system_stage"

View file

@ -8,7 +8,6 @@ repository = "https://github.com/bevyengine/bevy"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
keywords = ["bevy"] keywords = ["bevy"]
[dependencies] [dependencies]
bevy_app = { path = "../bevy_app", version = "0.5.0" } bevy_app = { path = "../bevy_app", version = "0.5.0" }
bevy_utils = { path = "../bevy_utils", version = "0.5.0" } bevy_utils = { path = "../bevy_utils", version = "0.5.0" }

View file

@ -8,8 +8,6 @@ repository = "https://github.com/bevyengine/bevy"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
keywords = ["bevy"] keywords = ["bevy"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
futures-lite = "1.4.0" futures-lite = "1.4.0"
event-listener = "2.4.0" event-listener = "2.4.0"

View file

@ -2,6 +2,9 @@
name = "errors" name = "errors"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
description = "Bevy's error codes"
publish = false
license = "MIT OR Apache-2.0"
[dependencies] [dependencies]
bevy = { path = "../" } bevy = { path = ".." }

8
errors/README.md Normal file
View file

@ -0,0 +1,8 @@
# Bevy Error Codes
This crate lists and tests explanations and examples of Bevy's error codes.
For the latest Bevy release, you can find a rendered version of the error code descriptions at
[bevyengine.org/learn/errors].
[bevyengine.org/learn/errors]: https://bevyengine.org/learn/errors

View file

@ -2,12 +2,13 @@
name = "bevy-ios-example" name = "bevy-ios-example"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
description = "Example for building an iOS app with Bevy"
publish = false
license = "MIT OR Apache-2.0"
[lib] [lib]
name = "bevy_ios_example" name = "bevy_ios_example"
crate-type = ["staticlib"] crate-type = ["staticlib"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
bevy = { path = "../../", features = [ "bevy_gilrs", "bevy_gltf", "bevy_wgpu", "bevy_winit", "render", "png", "hdr", "bevy_audio", "mp3"], default-features = false} bevy = { path = "../../", features = [ "bevy_gilrs", "bevy_gltf", "bevy_wgpu", "bevy_winit", "render", "png", "hdr", "bevy_audio", "mp3"], default-features = false}

View file

@ -2,8 +2,9 @@
name = "ci" name = "ci"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
description = "CI script for Bevy"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html publish = false
license = "MIT OR Apache-2.0"
[dependencies] [dependencies]
xshell = "0.1" xshell = "0.1"