INSTALL.md

Installation

Resuma is published on crates.io. API docs: docs.rs/resuma.

Resuma needs the Rust toolchain. Node only matters if you want to rebuild the JavaScript runtime (a fallback bundle ships in the repo).

Windows (PowerShell)

# Install rustup (the official Rust installer)
winget install --id Rustlang.Rustup -e
# Or via rustup directly:
Invoke-WebRequest -Uri https://win.rustup.rs/x86_64 -OutFile rustup-init.exe
.\rustup-init.exe -y

After installing, restart your terminal and verify:

rustc --version   # should print 1.91+
cargo --version

macOS / Linux

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Build the workspace

cd Resuma
cargo build

Cargo will pull every transitive dependency (axum, serde, tokio, syn, …) and compile every crate in the workspace.

Run an example

cargo run -p example-counter   # http://127.0.0.1:3000
cargo run -p example-todo

Optional: rebuild the JS runtime

The repo embeds loader.js, core.js, and legacy runtime.js under crates/resuma/assets/. To rebuild from TypeScript:

cd runtime
npm install
npm run build
npm run size   # raw + gzip + brotli report
cp dist/loader.js dist/core.js dist/runtime.js ../crates/resuma/assets/

Install the CLI

cargo install resuma
resuma --help

From the monorepo: cargo install --path crates/resuma --features cli

Troubleshooting

• error: linker not found on Windows — install MSVC build tools via Visual Studio Installer (Workloads → "Desktop development with C++").
• cargo not on PATH after install — close & reopen your terminal, or . "$HOME/.cargo/env".
• syn version mismatch — Resuma requires syn 2.x. If a downstream crate forces 1.x, cargo will resolve them in parallel; no action needed.