Guides

Welcome to the RouteRTL guide library. Choose a topic to get started.

Getting Started

• First Steps Tutorial — A 20-minute hands-on walkthrough covering project init, first simulation, linting, and waveform viewing.

Core Workflows

• SDK User Guide — Complete reference for project configuration, build system, quality control, Docker environments, embedded Linux, and the full CLI command reference.

• Cocotb Quickstart — Write and run your first Cocotb 2.0+ testbench with the RouteRTL simulation API, protocol drivers, and waveform viewing.

• Pre-Commit Guide — Automated quality checks and Git hook configuration.

Verification (the contract-first moat)

• Contract-First Start Here — Protocol catalog, install-to-gate sequence, and MCP tools.

• Contract-First Walkthrough — Take one IP from "scaffold the contract" to "CI gate on every push".

• Conformance-Monitor Hunt — The adversarial campaign: bolt the validated passive monitors onto every real DUT bus port and hunt for silicon-class protocol defects. Commands, the recipe, where defects cluster, and how the architecture (shared rr_cocotb_tb, rr sim run, the

• Driver Cookbook — Author a new BFM with an EMITS capability + a proving KAT.

• Assertion Quality — Non-vacuous, hard-coded-expected assertions (ROUTERTL-002).

Help

• Troubleshooting — Solutions for common issues with simulation, linting, synthesis, Docker, and embedded Linux.