From bcfe78b8804afc229146dd15f92c680c655bab65 Mon Sep 17 00:00:00 2001 From: Schmarni Date: Fri, 5 Jul 2024 03:51:11 +0200 Subject: [PATCH] add READMEs Signed-off-by: Schmarni --- Cargo.toml | 8 -------- crates/bevy_openxr/Cargo.toml | 6 +++++- crates/bevy_openxr/README.md | 6 ++++++ crates/bevy_webxr/README.md | 1 + crates/bevy_xr/Cargo.toml | 4 ++++ crates/bevy_xr/README.md | 3 +++ crates/bevy_xr_utils/README.md | 3 +++ src/lib.rs | 2 -- 8 files changed, 22 insertions(+), 11 deletions(-) create mode 100644 crates/bevy_openxr/README.md create mode 100644 crates/bevy_xr/README.md create mode 100644 crates/bevy_xr_utils/README.md delete mode 100644 src/lib.rs diff --git a/Cargo.toml b/Cargo.toml index 76cce57..09b7fa8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,3 @@ -[package] -name = "bevy_mod_xr_backends" -version.workspace = true -edition.workspace = true -description.workspace = true -repository.workspace = true -license.workspace = true - [workspace.package] version = "0.1.0-rc1" edition = "2021" diff --git a/crates/bevy_openxr/Cargo.toml b/crates/bevy_openxr/Cargo.toml index 792387d..c4e565b 100644 --- a/crates/bevy_openxr/Cargo.toml +++ b/crates/bevy_openxr/Cargo.toml @@ -1,7 +1,11 @@ [package] name = "bevy_mod_openxr" +description = "Community crate for OpenXR in Bevy" version.workspace = true edition.workspace = true +repository.workspace = true +license.workspace = true +keywords = ["gamedev", "bevy", "Xr", "Vr", "OpenXR"] [features] default = ["vulkan", "d3d12", "passthrough"] @@ -26,7 +30,7 @@ openxr = "0.18.0" thiserror = "1.0.57" wgpu = "0.20" wgpu-hal = "0.21" -bevy_mod_xr={path = "../bevy_xr",version = "0.1.0-rc1"} +bevy_mod_xr = { path = "../bevy_xr", version = "0.1.0-rc1" } ash = { version = "0.37.3", optional = true } diff --git a/crates/bevy_openxr/README.md b/crates/bevy_openxr/README.md new file mode 100644 index 0000000..3fc6125 --- /dev/null +++ b/crates/bevy_openxr/README.md @@ -0,0 +1,6 @@ +# Bevy mod OpenXR + +This is the OpenXR backend for bevy_mod_xr for more info see the [repo](https://github.com/awtterpip/bevy_oxr) + +![](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExY2FlOXJrOG1pbzFkYTVjZHIybndqamF1a2YwZHU3dXgyZGcwdmFzMiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/CHbQyXOT5yZZ1VQRh7/giphy-downsized-large.gif) +![](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExbHVmZXc2b3VhcGE2eHE2c2Y3NDR6cXNibHdjNjk5MmtyOHlkMXkwZyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/Hsvp5el2o7tzgOf9GQ/giphy-downsized-large.gif) diff --git a/crates/bevy_webxr/README.md b/crates/bevy_webxr/README.md index 4acdf44..743ec4d 100644 --- a/crates/bevy_webxr/README.md +++ b/crates/bevy_webxr/README.md @@ -1,2 +1,3 @@ # Bevy WebXR + currently not yet in a working state diff --git a/crates/bevy_xr/Cargo.toml b/crates/bevy_xr/Cargo.toml index 3f5c693..e305855 100644 --- a/crates/bevy_xr/Cargo.toml +++ b/crates/bevy_xr/Cargo.toml @@ -1,7 +1,11 @@ [package] name = "bevy_mod_xr" +description = "semi generic Xr Api for Community Driven XR in Bevy" version.workspace = true edition.workspace = true +license.workspace = true +repository.workspace = true +keywords = ["gamedev", "bevy", "Xr", "Vr"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/crates/bevy_xr/README.md b/crates/bevy_xr/README.md new file mode 100644 index 0000000..328c2b3 --- /dev/null +++ b/crates/bevy_xr/README.md @@ -0,0 +1,3 @@ +# Bevy Mod XR + +the shared api crate for bevy_mod_xr for more info see the [repo](https://github.com/awtterpip/bevy_oxr) diff --git a/crates/bevy_xr_utils/README.md b/crates/bevy_xr_utils/README.md new file mode 100644 index 0000000..9b42e6a --- /dev/null +++ b/crates/bevy_xr_utils/README.md @@ -0,0 +1,3 @@ +# Bevy XR Utils + +some optinal utils built on bevy_mod_xr and it's openxr backend diff --git a/src/lib.rs b/src/lib.rs deleted file mode 100644 index bcb4fdf..0000000 --- a/src/lib.rs +++ /dev/null @@ -1,2 +0,0 @@ -pub use bevy_mod_openxr; -pub use bevy_mod_xr;