Getting started

Your First Livt Project

Create one project in VS Code, validate it, run its test, and inspect the generated HDL.

Prerequisite: complete the managed installation, including GHDL when you want local simulation.

Create the project

  1. Open the Livt view in the Activity Bar.
  2. Select Create a new Livt project, or run Livt: New Livt Project.
  3. Choose a parent directory and enter a project name.
  4. Open the created project when prompted.

The project contains a manifest, source root, and test root:

text
HelloWorld/
├── livt.toml
├── src/
│   └── HelloWorld.lvt
└── tests/
    └── HelloWorldTest.lvt

Review the manifest

toml
[project]
name = "HelloWorld"
path = "src"
outdir = "out"

[tests]
path = "tests"
components = ["HelloWorldTest"]

livt.toml identifies the project, locates source and test files, and records settings that should be reproducible on another machine.

Add observable behavior

livt
namespace Livt.App

/**
- Reports a greeting and records how many greetings were emitted.
 */
component HelloWorld
{
	public greetingCount: int

	public fn Greet()
	{
		Simulation.Report("Hello, Livt! {this.greetingCount}")
		this.greetingCount++
	}
}

Run the test

Open the Livt Tests view or VS Code Test Explorer and run HelloWorldTest. A successful run reports the greeting and one passing test.

You can run the complete project from its context menu with Test Livt Project. Test failures link back to the relevant source when location information is available.

Validate and build

  1. Choose Validate Livt Project for the smallest saved-project check.
  2. Resolve diagnostics from the Problems view.
  3. Choose Build Livt Project.
  4. Expand Outputs in the Livt Project view and inspect the generated VHDL.

Generated output is an integration artifact. Change Livt source or configuration and rebuild instead of editing files below out/.

Continue with the VS Code workflow or learn the building blocks of Livt.