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 26d9fdc commit 2204134
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@ Install from [PyPi](https://pypi.org/project/peakrdl-html) using pip:

The easiest way to use PeakRDL-html 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 HTML
peakrdl html your_design.rdl -o output_dir
```bash
# Install the command line tool
python3 -m pip install peakrdl

# Generate HTML
peakrdl html your_design.rdl -o output_dir
```

Here is an [example of HTML output](https://systemrdl.github.io/PeakRDL-html) generated from a
fictional SystemRDL register description: [turboencabulator.rdl](example/turboencabulator.rdl).
Expand Down

0 comments on commit 2204134

Please sign in to comment.