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.
command_abc
-key1 key1
[-flag1]
[-flagDev]
arg1
Options#
Switch Name |
Description |
---|---|
|
Description for |
|
Description for |
|
Description for |
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 |
---|---|
|
Description for |
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 |
---|---|
|
Debug something. |
Example scripts#
Examples scripts demonstrating …
./test/asdfg.tcl
Regression tests#
There are a set of regression tests in ./test
. Refer to this section for more information.
Simply run the following script:
./test/regression
Limitations#
FAQs#
Check out GitHub discussion about this tool.
References#
License#
BSD 3-Clause License. See LICENSE file.