Skip to content

Commit

Permalink
Add readme to errors crate and clean up cargo files (#3125)
Browse files Browse the repository at this point in the history
# 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
  • Loading branch information
NiklasEi committed Nov 13, 2021
1 parent d0f423d commit 94db017
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 9 deletions.
5 changes: 4 additions & 1 deletion benches/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
name = "benches"
version = "0.1.0"
edition = "2021"
description = "Benchmarks for Bevy engine"
publish = false
license = "MIT OR Apache-2.0"

[dev-dependencies]
criterion = "0.3"
bevy = { path = "../" }
bevy = { path = ".." }

[[bench]]
name = "system_stage"
Expand Down
1 change: 0 additions & 1 deletion crates/bevy_log/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ repository = "https://github.com/bevyengine/bevy"
license = "MIT OR Apache-2.0"
keywords = ["bevy"]


[dependencies]
bevy_app = { path = "../bevy_app", version = "0.5.0" }
bevy_utils = { path = "../bevy_utils", version = "0.5.0" }
Expand Down
2 changes: 0 additions & 2 deletions crates/bevy_tasks/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ repository = "https://github.com/bevyengine/bevy"
license = "MIT OR Apache-2.0"
keywords = ["bevy"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
futures-lite = "1.4.0"
event-listener = "2.4.0"
Expand Down
5 changes: 4 additions & 1 deletion errors/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "errors"
version = "0.1.0"
edition = "2021"
description = "Bevy's error codes"
publish = false
license = "MIT OR Apache-2.0"

[dependencies]
bevy = { path = "../" }
bevy = { path = ".." }
8 changes: 8 additions & 0 deletions errors/README.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 3 additions & 2 deletions examples/ios/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
name = "bevy-ios-example"
version = "0.1.0"
edition = "2021"
description = "Example for building an iOS app with Bevy"
publish = false
license = "MIT OR Apache-2.0"

[lib]
name = "bevy_ios_example"
crate-type = ["staticlib"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
bevy = { path = "../../", features = [ "bevy_gilrs", "bevy_gltf", "bevy_wgpu", "bevy_winit", "render", "png", "hdr", "bevy_audio", "mp3"], default-features = false}
5 changes: 3 additions & 2 deletions tools/ci/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "ci"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
description = "CI script for Bevy"
publish = false
license = "MIT OR Apache-2.0"

[dependencies]
xshell = "0.1"

0 comments on commit 94db017

Please sign in to comment.