hathach/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-10-17 23:55:34 +08:00
Code Issues Projects Releases Wiki Activity

move mcu supported to README.rst, separated supported boards to boards.rst

Browse Source
This commit is contained in:
hathach
2024-12-27 09:58:07 +07:00
parent 6a36c74b10
commit 824793a428
7 changed files with 175 additions and 532 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tools/gen_doc.py
View File

@@ -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'))