search

bmpenuelas / waveform-render-vscode

Render waveforms inside VSCode with WaveDrom
MIT License
34 stars 4 forks source link

readme

waveform-render-vscode

Render waveforms with WaveDrom inside VSCode.

This VSCode extension is available on the VSCode Extension Marketplace.

Usage

:page_with_curl: Open a JSON file containing a WaveDrom waveform, like

{ signal: [
  { name: "clk",         wave: "p.....|..." },
  { name: "Data",        wave: "x.345x|=.x", data: ["head", "body", "tail", "data"] },
  { name: "Request",     wave: "0.1..0|1.0" },
  {},
  { name: "Acknowledge", wave: "1.....|01." }
]}



:musical_keyboard: Press "Ctrl+K followed by Ctrl+D", or "Ctrl+Shift+P followed by Waveform Render: Draw" to draw the waveform in your editor

or

:arrows_clockwise: Press "Ctrl+K followed by Ctrl+L", or "Ctrl+Shift+P followed by Waveform Render: Toggle Live Preview" to make the waveform update as you type



:rainbow: and you will get a new tab with a nice waveform rendered inside your text editor waveform render vscode example


You can find the complete WaveDrom syntax in the WaveDrom schema docs.