ZLANG HDL / GET-STARTED

Install and run the compiler

Set up the alpha toolchain, check the Counter example, and run native simulation.

Community alpha candidate 0.1.0a24. Supported native platform: Linux x86-64, including WSL2, with CPython ≥3.12 and <3.13. A checked-in candidate is not necessarily a published release.
01 / PREPARE THE TOOLCHAIN

Start from the
public checkout.

The checkout setup installs its matching native simulation runtime. See the installation guide for external EDA tools and editor requirements.

make venv can refresh the VS Code extension on supported hosts. Set INSTALL_EDITOR=0 to leave your editor unchanged.

Full installation guide ↗
terminal
git clone https://github.com/postoroniy/zlang-hdl.git
cd zlang-hdl
git checkout --detach c768da0bce8b386171f155068d500731a499c7b1
make venv
source .venv/bin/activate
02 / CHECK AND SIMULATE

Make every
bit explicit.

Run the semantic checker against the checked-in Counter example. The site does not execute compilation in your browser.

terminal
zlang examples/counter.zhl --top Counter --check
zlang sim examples/counter.zhl --top Counter \
  --events examples/counter.events.jsonl \
  --trace build/counter.fst
03 / INSPECT THE RESULT

Follow the signal.

Open the saved waveform in the matching ZLang HDL VS Code extension. Add Counter.clk, Counter.rst, and Counter.y from the Design Browser.

Continue with the tutorial ↗