File size: 2,235 Bytes
d59bb1b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | # Tool Name
The top-level READMEs in each tool folder (`~/OpenROAD/src/<tool>/README.md`)
has to be formatted in this particular manner. For most part, you can copy
the format and replace the contents where necessary.
## Commands
```{note}
- Parameters in square brackets `[-param param]` are optional.
- Parameters without square brackets `-param2 param2` are required.
```
### Command ABC
```{note}
Please add a description, even a one-liner will be sufficient to
avoid triggering CI errors.
```
The `command_abc` command performs...
The developer arguments are...
Note for commands, you must adhere to the top-level Tcl definition
for the same command.
- Arguments: cannot be preceded with dashes
- Flags/Keys: verify if it is optional or required, then insert the
necessary square brackets. Also, keys have to be followed with a specifier
whereas flags only require the `-flag` itself.
As far as possible, do place the positional arguments last.
```tcl
command_abc
-key1 key1
[-flag1]
[-flagDev]
arg1
```
#### Options
| Switch Name | Description |
| ----- | ----- |
| `arg1` | Description for `arg1`. |
| `-key1` | Description for `key1`. |
| `-flag1` | Description for `flag1`. |
#### Developer Arguments
If there are some developer arguments you want to highlight to the end user
not to worry about - you can park them in the same level below the main
`Options` category.
| Switch Name | Description |
| ----- | ----- |
| `-flagDev` | Description for `flagDev`. |
## Useful Developer Commands
If you are a developer, you might find these useful. More details can be found in the [source file]() or the [swig file]().
| Command Name | Description |
| ----- | ----- |
| `command_abc_debug` | Debug something. |
## Example scripts
Examples scripts demonstrating ...
```shell
./test/asdfg.tcl
```
## Regression tests
There are a set of regression tests in `./test`. Refer to this [section](../../README.md#regression-tests) for more information.
Simply run the following script:
```shell
./test/regression
```
## Limitations
## FAQs
Check out [GitHub discussion]()
about this tool.
## Authors
## References
## License
BSD 3-Clause License. See [LICENSE](../../LICENSE) file. |