docs: add third_party/README with vendoring instructions; augment root README with crate vendoring guidance

This commit is contained in:
MayaTheShy
2025-11-08 13:59:32 -05:00
parent 1987b6221f
commit 90e2974852
2 changed files with 52 additions and 0 deletions

35
third_party/README.md vendored Normal file
View File

@@ -0,0 +1,35 @@
# Third-Party Crates
To enable deeper integration and inspection of StardustXR client behavior, place local clones of the following repositories here:
- `asteroids/` (https://github.com/StardustXR/asteroids)
- `core/` (https://github.com/StardustXR/core) — provides fusion client elements
Recommended structure:
```
third_party/
asteroids/
core/
```
After cloning, you can update `bridge/Cargo.toml` to use `path` dependencies instead of `git` to ensure reproducible builds and easier iteration:
```
[dependencies.stardust-xr-asteroids]
path = "../third_party/asteroids"
[dependencies.stardust-xr-fusion]
path = "../third_party/core"
```
Then run:
```bash
cargo update
cargo build -p stardust_bridge
```
This lets us:
- Inspect and modify client crate code during debugging
- Pin exact revisions without relying on remote branches
- Potentially implement custom elements or expose more C ABI hooks
If you prefer not to vendor the crates, please confirm the exact commit SHAs you want pinned and we can lock them in `Cargo.toml` instead of the moving `dev` branch.