Skip to content

Commit 2a546b0

Browse files
committed
exa: update README
Signed-off-by: Matt Liberty <[email protected]>
1 parent 908aeab commit 2a546b0

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/exa/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
Example
1+
# Example
2+
3+
This is an example tool to demonstrate how to setup a new tool in OpenROAD.
4+
5+
## Commands
6+
7+
### Example Instance
8+
9+
This command makes an instance.
10+
11+
```tcl
12+
example_instance
13+
[-name name]
14+
```
15+
16+
#### Options
17+
18+
| Switch Name | Description |
19+
| ----- | ----- |
20+
| `[-name]` | The name of the instance to create`. Defauts to example. |

0 commit comments

Comments
 (0)