add example

SystemRDL · Nov 8, 2023 · 92036db · 92036db
1 parent 7161cbf
commit 92036db
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,15 @@ Export a compiled register model into SystemRDL code.
 Useful when converting from other imported file formats.
 
 For the command line tool, see the [PeakRDL project](https://peakrdl.readthedocs.io).
+
+## Example
+
+The easiest way to use PeakRDL-systemrdl is via the [PeakRDL command line tool](https://peakrdl.readthedocs.io/):
+
+```bash
+# Install the command line tool
+python3 -m pip install peakrdl
+
+# Convert IP-XACT to SystemRDL
+peakrdl systemrdl your_design.xml -o your_design.rdl
+```