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:
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