Skip to content

Commit 04711df

Browse files
authored
Documentation Updates (#66)
* images * readme Signed-off-by: Jens Reinecke <jens.reinecke@arm.com> --------- Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent 85c5dab commit 04711df

8 files changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1-
# Embedded Peripheral Inspector
1+
# Peripheral Inspector
22

3-
Standalone SVD Viewer extension extracted from [cortex-debug](https://github.com/Marus/cortex-debug)
3+
This standalone SVD Viewer extension is extracted from [cortex-debug](https://github.com/Marus/cortex-debug) and allows
4+
you to view and change on-chip peripheral settings.
5+
6+
## Usage
7+
8+
The **Peripheral Inspector** displays information about peripheral registers.
9+
10+
![Peripheral Inspector](./media/peripheral-inspector.png)
11+
12+
Depending on the context, the following icons may be visible:
13+
14+
| Icon | Use it to |
15+
|------|-----------|
16+
| ![Collapse](./media/CollapseAll.png) | Collapse currently viewed peripherals |
17+
| ![Search](./media/Search.png) | Open search bar to find specific properties |
18+
| ![Refresh](./media/Reload.png) | Refresh the current view |
19+
| ![Export](./media/Export.png) | Export peripheral registers |
20+
| ![Edit](./media/Edit.png) | Update the register value |
421

522
## Specifying SVD Files
623

media/CollapseAll.png

386 Bytes
Loading

media/Edit.png

550 Bytes
Loading

media/Export.png

458 Bytes
Loading

media/MoreOptions.png

250 Bytes
Loading

media/Reload.png

605 Bytes
Loading

media/Search.png

683 Bytes
Loading

media/peripheral-inspector.png

55.1 KB
Loading

0 commit comments

Comments
 (0)