๐ Get Started โ
Use this page to pick the fastest path to a first successful run.
Choose your path โ
- First-time user (5-10 min): ๐ฅ๏ธ Use on Host
- Integrator (15-30 min): ๐ฅ๏ธ Use on Host
- WASM app developer (10-20 min): ๐ Use on WASM
- Contributor (20-40 min): ๐ค Contribute
Checklist links:
Preflight checklist โ
Before you start, confirm:
- Rust is installed:
rustc --version - Cargo works:
cargo --version - You chose one target path (host, wasm, or contribution)
- You can run commands from a clean project folder
Quick start commands โ
Pick one path and run the matching command sequence:
Host โ
bash
git clone https://github.com/Xila-Project/Core.git
cd Core
cargo make run -p native_exampleWASM โ
bash
git clone https://github.com/Xila-Project/Core.git
cd Core
rustup target add wasm32-wasip1
cargo build -p wasm --target wasm32-wasip1Contributor โ
bash
git clone https://github.com/Xila-Project/Core.git
cd Core
cargo make before-commitSuccess outcomes โ
You are "started" when you can do one of these:
- Host path: run a host app and see it start without panics
- Integrator path: initialize modules, mount runtime services, and launch one executable in your workspace
- WASM path: build a
wasm32-wasip1binary without target errors - Contributor path: run both native and wasm examples locally
Troubleshooting โ
cargo make: command not found: installcargo-make(cargo install cargo-make).- target missing errors for wasm: run
rustup target add wasm32-wasip1. - build failures after dependency updates: run formatting/check tasks from
contribute.md.
Architecture maps โ
Use these while onboarding to understand the system boundaries:
Next steps โ
- Continue with ๐ฅ๏ธ Use on Host for local runtime setup.
- Continue with ๐ Use on WASM for guest app workflow.
- Continue with ๐ค Contribute for contributor workflow.