diff --git a/README.md b/README.md index 0e94b00..45998c9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # Tiny Tapeout tools Tools used mostly by the Tiny Tapeout github actions + +## Documentation + +* checks that basic fields are present in the info.yaml +* create a PDF data sheet for this one design +* create SVG and PNG renders of the project's GDS + +## Reports + +* routing & utilisation +* yosys warnings +* standard cell usage and summary + +## Configuration + +* creates a little TCL shim that tells OpenLane where the source is and the name of the top module +* makes sure the top module is not called 'top' diff --git a/tt_tool.py b/tt_tool.py index 6a4ed81..66977c7 100755 --- a/tt_tool.py +++ b/tt_tool.py @@ -12,9 +12,6 @@ if __name__ == '__main__': parser.add_argument('--run-dir', help="OpenLane run directory", default='runs/wokwi') # set in the github action yaml parser.add_argument('--debug', help="debug logging", action="store_const", dest="loglevel", const=logging.DEBUG, default=logging.INFO) - # tests & checks - parser.add_argument('--check-docs', help="check the documentation part of the yaml", action="store_const", const=True) - # reports & summaries parser.add_argument('--create-cell-defs', help="create def file", action="store_const", const=True, default=False) parser.add_argument('--print-cell-summary', help="print summary", action="store_const", const=True, default=False) @@ -23,6 +20,7 @@ if __name__ == '__main__': parser.add_argument('--print-warnings', help="print any warnings", action="store_const", const=True) # documentation + parser.add_argument('--check-docs', help="check the documentation part of the yaml", action="store_const", const=True) parser.add_argument('--create-pdf', help="create a single page PDF", action="store_const", const=True) parser.add_argument('--create-svg', help="create a svg of the GDS layout", action="store_const", const=True) parser.add_argument('--create-png', help="create a png of the GDS layout", action="store_const", const=True)