From 920b2111db7e367b96aba690a5ca6f186afff8c8 Mon Sep 17 00:00:00 2001 From: Alex Mykyta Date: Wed, 9 Nov 2022 23:24:20 -0800 Subject: [PATCH] Add linkback to cli tool on front page --- docs/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index c9615a8..d2722ca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,14 @@ Install from `PyPi`_ using pip Quick Start ----------- +The easiest way is to use the `PeakRDL command line tool `_: +.. code-block:: bash + + peakrdl regblock atxmega_spi.rdl -o regblock/ --cpuif apb3-flat + + +Otherwise if you want, there is a Python API. Below is a simple example that demonstrates how to generate a SystemVerilog implementation from SystemRDL source.