Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
amykyta3 committed Nov 8, 2023
1 parent d1bc2f4 commit db696fc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ Install from `PyPi`_ using pip

Quick Start
-----------
The easiest way is to use the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_:
The easiest way to use PeakRDL-ipxact is via the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_:

.. code-block:: bash
# Install the command line tool
python3 -m pip install peakrdl
# Generate a C header
peakrdl c-header example.rdl -o example.h
Using the generated header, you can access your device registers by name!
Expand Down

0 comments on commit db696fc

Please sign in to comment.