Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 2.29 KB

ReadmeFormat.md

File metadata and controls

105 lines (71 loc) · 2.29 KB
Raw

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

- Parameters in square brackets `[-param param]` are optional.
- Parameters without square brackets `-param2 param2` are required.

Command ABC

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.

Place the positional arguments last.

command_abc
    -key1 key1   
    [-flag1]
    [-flagDev]
    arg1

Arguments must follow this order and be sorted alphabetically within each category:

  1. Mandatory flags
  2. Optional flags
  3. Positional

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 ...

./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.

Authors

References

License

BSD 3-Clause License. See LICENSE file.