Skip to content

Godhart/vdf

Repository files navigation

VDF - Versatile Description Format aka Универсальный Формат Описания

main build

intro

Идея данного проекта

Не надо создавать новый стандарт! Просто совмести те, что уже есть!

Объединяй описание и код в одном документе и используй для этого тот формат, который ты хочешь (или что-то вроде)

Хорошо. Но тебе всё же понадобится ещё один стандарт для этого...

Более подробные детали данной идеи можно посмотреть в черновике спецификации

Вот небольшой пример того как это могло бы выглядеть.

И ещё один наглядный пример в облаке

Текущее состояние проекта

Имеется спецификация на уровне черновика. Многие вещи пока что ещё могут изменяться без обратной совместимости. Есть ещё много над чем подумать и что проверить.

По этой спецификации уже реализовано ядро системы на уровне, достаточном для проверки гипотез и предварительной оценки.

Первая цель применения данной спецификации - языки описания аппаратуры, тике как VHDL, Verilog. Но в целом спецификация позволяет расширять её применение и на другие языки программирования.

На текущем уровне реализации уже можно выполнять интерактивный ввод исходного файла на языке VHDL и его симуляцию.

Чтобы ознакомиться на практике с текущими возможностями воспользуйтесь этим руководством и списком доступных команд.

Направление планов по развитию проекта можно посмотреть в этой дорожной карте.

Был обнаружен проект, в котором много идей уже реализовано - Quarto. В ближайшем времени принципы проекта VDF будут пересмотрены с точки зрения интеграции с Quarto.

За анонсами проекта можно наблюдать в телеграм-канале @vdfspec.

Участие в проекте

Проект открытый и участие в нём приветствуется.

Проект пока ещё очень молод и общая стратегия для участия в нём пока не определена, но при желании вы можете в частном порядке связаться с автором по почте godhart@gmail.com или телеграм @Godhart и обговорить детали участия.

Какие технологии используются в проекте

Ядро системы

  • Python
  • Jupyter
  • JSON
  • YAML
  • TOML
  • Jinja2

Форматы описания

  • Markdown
  • и в планах поддержать больше ...

RTL инструментарий

  • GHDL
  • Cocotb
  • wavedrom
  • и в планах поддержать больше ...

About

Versatile Document Format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published