README.md

PeakRDL-Markdown

This package implements Markdown exporter for the PeakRDL toolchain.

• Export: Convert compiled SystemRDL input into Markdown description.

For the command line tool, see the PeakRDL project.

Usage

PeakRDL project provides a standard CLI interface. It can be installed directly via pip:

$ pip install peakrdl-markdown

Then this package can be used with the following command:

$ peakrdl markdown input_file.rdl -o output_file.md

Documentation

See the PeakRDL-Markdown Documentation for more details.