Skip to main content

ROOT_README_TEMPLATE

Constant ROOT_README_TEMPLATE 

Source
const ROOT_README_TEMPLATE: &str = "# {{ project_name }}\n\nThis template contains:\n\n- `.gitignore`: ignores local build artifacts\n- `guest/`: Airbender guest program\n- `host/`: host-side runner/prover application\n- `guest/.cargo/config.toml`: guest target and build flags for local tooling\n\n## Quick Start\n\nBuild guest artifacts:\n\n```sh\ncd guest\ncargo airbender build\n```\n\nRun host execution:\n\n```sh\ncd ../host\ncargo run --release\n```\n\nRun host execution + proof:\n\n```sh\ncargo run --release -- --prove\n```\n\n## Prover Backend\n\n{{ prover_backend_doc }}\n";