🚀 Get started with contributing

This guide will help you get started with contributing to the Xila project by building and running the core examples.

✅ Requirements

Ensure the following dependencies are installed to build the core:

• gcc-multilib: Required for cross-compilation.
• cargo-make: Used to build the project with cargo.
• nodejs: Needed to generate fonts for LVGL (lv_font_conv).
• wasm32-wasip1 Rust target: Required to compile Xila virtual machine executables.
• (Optional) wasm32-unknown-unknown Rust target: Used to compile the wasm_example.
• (Optional) nightly Rust toolchain: Needed to compile the wasm_example.
• (Optional) trunk: Used to build the wasm_example.
• (Optional) Rust xtensa-esp32*-espidf toolchain: For compiling for ESP32 / ESP32-S series.
• (Optional) Rust riscv*-esp-espidf: For compiling for ESP32-H / ESP32-C series.

📖 Steps

1. Clone the repository:

git clone https://github.com/Xila-Project/Core.git

2. Navigate to the project directory:

cd Core

3. Run one of the examples (desktop or web):
   • For the native example:

cargo make run -p native_example

• For the WASM example:

cargo make generate-fonts
cd examples/wasm && trunk serve

INFO

For the full list of available commands, refer to the Makefile.toml.