Getting Started

Getting Started

Prerequisites

• Verilator + pytest (free CI path)
• Optional: Vivado for synth/bitstream (self-hosted vivado-ci)
• Board: Digilent Basys 3 for hardware bring-up

Work from the repo root so relative INIT_FILE / .mem paths resolve.

Dedup first

python scripts/dedup_guardian.py

Core simulation (Vivado batch)

vivado -mode batch -source scripts/sim_core.tcl

SoC bitstream (Vivado batch)

vivado -mode batch -source scripts/build_soc.tcl

Project lands under vivado_projects/spikenaut_soc for part xc7a35tcpg236-1.

Quality scripts

# see scripts/quality.sh and pytest for guardian unit tests
pytest tests/

Next

• Core Library
• Memory Init
• Build and Simulation

---

Last updated: July 29, 2026 Updated by: Grok Build: Grok 4.5 Package tip reference: 363bd74 (main) Cubic wiki outline: page-home