diff --git a/README.md b/README.md index 89e8469..6a5e2ce 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,11 @@
-An open-source cross-platform cockpit for Boats, targeting Windows, macOS, Linux, WebAssembly, Android, and iOS. +An open-source virtual cockpit for Windows, macOS, Linux, Web, Android, and iOS.
-### prereqs + +### shrimp - cargo/Rust ### grits @@ -22,4 +23,4 @@ git clone https://github.com/seemueller-io/yachtpit.git && cd yachtpit cargo check cargo run -``` \ No newline at end of file +``` diff --git a/crates/components/README.md b/crates/components/README.md new file mode 100644 index 0000000..f08763e --- /dev/null +++ b/crates/components/README.md @@ -0,0 +1,8 @@ +# yachtpit/crates/components +Provides components and rendering utilities for yachtpit. + +## Overview +The `components` crate contains components and rendering primitives built on top of Bevy's engine. + +## Usage +This crate is designed to be used internally within the yachtpit project and is not published to crates.io. It exports foundational components used by the `systems` and `yachtpit` crates. \ No newline at end of file diff --git a/crates/systems/README.md b/crates/systems/README.md new file mode 100644 index 0000000..517c1f4 --- /dev/null +++ b/crates/systems/README.md @@ -0,0 +1,9 @@ +# yachtpit/crates/systems +This crate provides Bevy-based systems and logic for yachtpit. + +## Overview +The `systems` crate contains the core systems and logic built on top of Bevy's engine. +It depends on the `components` crate and extends it with domain-specific systems, behaviors, and randomization utilities. + +## Usage +This crate is designed to be used internally within the yachtpit project and is not published to crates.io. It provides the game systems layer that bridges the foundational components with the main application logic. \ No newline at end of file diff --git a/crates/yachtpit/README.md b/crates/yachtpit/README.md new file mode 100644 index 0000000..536f73a --- /dev/null +++ b/crates/yachtpit/README.md @@ -0,0 +1,18 @@ +# yachtpit/crates/yachtpit +This is the main application crate for yachtpit. + +## Overview +The `yachtpit` crate unifies components and systems into an application. +It supports several runtimes to include web, desktop, and mobile platforms. + +## Usage +### Native +```bash +cargo run --features dev +``` +### Web +```bash +trunk serve +``` +### Mobile +See the `mobile/` directory for platform-specific build instructions. \ No newline at end of file