mirror of
https://github.com/seemueller-io/yachtpit.git
synced 2025-09-08 22:46:45 +00:00
Add READMEs for components
, systems
, and yachtpit
crates; update project overview in root README.
This commit is contained in:
8
crates/components/README.md
Normal file
8
crates/components/README.md
Normal file
@@ -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.
|
9
crates/systems/README.md
Normal file
9
crates/systems/README.md
Normal file
@@ -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.
|
18
crates/yachtpit/README.md
Normal file
18
crates/yachtpit/README.md
Normal file
@@ -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.
|
Reference in New Issue
Block a user