Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

What we learned

A short look back at the Tour, and where the Tutorial picks up.

Before you start

  • Window: none. This page has nothing to type.
  • Folder: none. Your work is in volt-projects: the project blinky and the single design in cdc.
  • Running: nothing. You may close Docker Desktop until the next volt test.

In Setup you installed a single binary and asked volt doctor what works on your machine. Then, in about 15 minutes, you have:

  • created a project with volt new, checked it with volt check and turned it into readable SystemVerilog with volt build;
  • written a design with two clock domains in a folder of its own, seen the compiler reject a crossing without a synchronizer (E3001), and fixed it with sync();
  • run simulation tests with volt test, with Verilator running in Docker, and read the cover summary;
  • followed a failing test to its waveform, where a state register shows the names of its states.

The commands you used:

CommandWhat it doesNeeds
cd FOLDERmakes FOLDER the working folder of the terminalnothing
volt new NAMEcreates a project from a templatenothing
volt checkfinds errors, writes no filesnothing
volt buildwrites SystemVerilog to build/rtl/nothing
volt testruns the test blocks of the projectVerilator, or Docker Desktop running
volt explain CODEexplains an error code or a topicnothing
volt doctorsays which commands work herenothing

Two commands did not come up: volt verify, which proves contracts for every input sequence, and volt run, which simulates a design without tests. The Tutorial covers both.

Next

Part II, the Tutorial, starts again from a blank file and builds a counter line by line: modules, ports, registers, clocked blocks, bit widths and tests. Each later chapter adds one idea on top.