diff options
| author | hathach <[email protected]> | 2024-12-27 09:58:07 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2024-12-27 11:34:35 +0700 |
| commit | 824793a428aea082b4ae887ce7a26b4736e1d2cc (patch) | |
| tree | ffe24c44e4349eb0599a0517c7aaed81e8c6e5d1 /tools | |
| parent | 6a36c74b10b25f1455d83ba473fff52a9dbcc6d2 (diff) | |
move mcu supported to README.rst, separated supported boards to boards.rst
Diffstat (limited to 'tools')
| -rwxr-xr-x | tools/gen_doc.py | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/tools/gen_doc.py b/tools/gen_doc.py index 318ff8089..ab07bc116 100755 --- a/tools/gen_doc.py +++ b/tools/gen_doc.py @@ -92,13 +92,18 @@ def gen_boards_doc(): Supported Boards **************** -Following boards are supported and can be used to run stock examples +The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project. +It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices -""" +- One LED : for status +- One Button : to get input from user +- One UART : needed for logging with LOGGER=uart, maybe required for host/dual examples + +Following boards are supported""" f.write(title) for manuf, boards in sorted(vendor_data.items()): f.write(f"\n\n{manuf}\n") - f.write(f"{'=' * len(manuf)}\n\n") + f.write(f"{'-' * len(manuf)}\n\n") df = pd.DataFrame.from_dict(boards, orient='index', columns=['Name', 'Family', 'URL', 'Note']) df = df.rename_axis("Board") f.write(tabulate(df, headers="keys", tablefmt='rst')) |
