RouteRTL Documentation
Project Configuration
| Document | Description |
|---|---|
| project.yml Reference | Complete project.yml specification — every field, every option |
CLI Reference
| Document | Description |
|---|---|
| SDK User Guide | All rr commands, flags, and usage examples |
Tutorials
| Document | Description |
|---|---|
| Installation | Platform setup, prerequisites, and first install |
| First Steps Tutorial | Hands-on 20-minute tutorial for new users |
| Project Initialization | rr init command and project templates |
| Cocotb Quickstart | Writing and running simulations |
| Docker Workflow | Running EDA tools in containers |
| Pre-Commit Guide | Automated quality checks before every commit |
Migration
| Document | Description |
|---|---|
| Migration Guide | Convert existing Vivado projects to RouteRTL with rr migrate |
Reference Designs
| Document | Description |
|---|---|
| Reference Designs | 6 ready-to-run templates — from blinky to production SPI sensor |
API Reference
| Document | Description |
|---|---|
| API Overview | API documentation index |
| Testbench Environment | TbEnv class — clock, reset, logging, monitors |
| Simulation Runner | run_simulation() function reference |
| AXI-Lite Driver | AXI-Lite master/slave BFM |
| AXI4 Driver | AXI4 full burst-capable BFM |
| Avalon-MM Driver | Avalon memory-mapped BFM |
| UART Driver | UART transmitter/receiver |
| SPI Driver | SPI master (all 4 modes) |
| I2C Driver | I2C master with clock stretching |
| Native Memory Driver | Direct memory interface |