README

RapidRTL Documentation

Welcome to the RapidRTL documentation index. This folder contains project-wide documentation and links to component-specific READMEs.

🔧 Tool Documentation

ToolDescriptionREADME
regbank-utilsYAML → HDL/Python/C register generationREADME
system-builderPlatform-specific VHDL config generationREADME
cocotb-testgenAuto-generate cocotb test stubs from VHDLREADME
test-visualizationWaveform trimming & burst analysisREADME
report-analyzerVivado report parsing utilitiesREADME
vivado-dockerContainerized Vivado environmentREADME
project-managerCentralized YAML-based build configREADME

🏗️ Build System

DocumentDescription
System Builder FlowVHDL configuration generation flow
Xilinx Build FlowAnalysis of the Xilinx/Vivado build process
Altera Build FlowAnalysis of the Altera/Quartus build process

🧪 Simulation Documentation

ComponentDescriptionDocumentation
Cocotb TestsPython-based testbenchesREADME
Backend DevelopmentGuide for adding new simulatorsBACKEND_DEVELOPMENT.md

🔄 CI/CD

PlatformConfigurationStatus
GitHub Actions.github/workflows/ci.ymlTier 1 + Tier 2
Bitbucket Pipelinesbitbucket-pipelines.ymlTier 1 + Tier 2

Test Tiers

TierTestsTrigger
Tier 1regbank-utils, Makefile testsEvery push
Tier 2Cocotb simulation (GHDL)PRs, main branch

📁 Quick Links

📝 Contributing

Coming soon: CONTRIBUTING.md with coding standards and PR guidelines.

📊 Reports

ReportDescription
Analysis Report (2026-01-20)Technical pros/cons analysis and improvement suggestions

Generated from repository analysis on 2026-01-20