Awesome

Introduction

This document contains specification of Domain Specific Language (DSL), called CommsDSL, for CommsChampion Ecosystem, used to define custom binary protocols. The defined schema files are intended to be parsed and used by commsdsl library and code generation application(s).

The PDF can be downloaded from release artifacts of this project. The online HTML documentation is hosted on github pages.

The specification is written using asciidoctor and buildable using CMake

Toolchain setup

For a more detailed version go to https://asciidoctor.org/#installation

Newest asciidoctor version

For asciidoctor the ruby version 2.7 is necessary.

Head over to the ruby install instructions. Note for windows: If you already have chocolatey installed, you simply can run choco install ruby

Install asciidoctor, asciidoctor-pdf and the syntax highlighter with:

$> gem install asciidoctor
$> gem install asciidoctor-pdf
$> gem install rouge

How to Build

$> mkdir build && cd build
$> cmake ..
$> make pdf                # <-- Builds PDF
$> make site               # <-- Builds HTML