From 94db0176fecfac7e7e9763f2dc7458a54c105886 Mon Sep 17 00:00:00 2001
From: Niklas Eicker <git@nikl.me>
Date: Sat, 13 Nov 2021 23:06:48 +0000
Subject: [PATCH] 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
---
 benches/Cargo.toml           | 5 ++++-
 crates/bevy_log/Cargo.toml   | 1 -
 crates/bevy_tasks/Cargo.toml | 2 --
 errors/Cargo.toml            | 5 ++++-
 errors/README.md             | 8 ++++++++
 examples/ios/Cargo.toml      | 5 +++--
 tools/ci/Cargo.toml          | 5 +++--
 7 files changed, 22 insertions(+), 9 deletions(-)
 create mode 100644 errors/README.md

diff --git a/benches/Cargo.toml b/benches/Cargo.toml
index 4626d6343d..bb3aab4c1c 100644
--- a/benches/Cargo.toml
+++ b/benches/Cargo.toml
@@ -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"
diff --git a/crates/bevy_log/Cargo.toml b/crates/bevy_log/Cargo.toml
index 20096e8e42..4b8027adb9 100644
--- a/crates/bevy_log/Cargo.toml
+++ b/crates/bevy_log/Cargo.toml
@@ -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" }
diff --git a/crates/bevy_tasks/Cargo.toml b/crates/bevy_tasks/Cargo.toml
index c40468c6bf..eba4092173 100644
--- a/crates/bevy_tasks/Cargo.toml
+++ b/crates/bevy_tasks/Cargo.toml
@@ -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"
diff --git a/errors/Cargo.toml b/errors/Cargo.toml
index a64061f078..07ad946b1a 100644
--- a/errors/Cargo.toml
+++ b/errors/Cargo.toml
@@ -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 = ".." }
diff --git a/errors/README.md b/errors/README.md
new file mode 100644
index 0000000000..be2adb2b00
--- /dev/null
+++ b/errors/README.md
@@ -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
diff --git a/examples/ios/Cargo.toml b/examples/ios/Cargo.toml
index 8159df555e..81253d5edc 100644
--- a/examples/ios/Cargo.toml
+++ b/examples/ios/Cargo.toml
@@ -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}
diff --git a/tools/ci/Cargo.toml b/tools/ci/Cargo.toml
index 8cf9645806..3c2a6ee93c 100644
--- a/tools/ci/Cargo.toml
+++ b/tools/ci/Cargo.toml
@@ -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"