Skip to content

docs: add board product images to bilingual README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Y1hsiaochunnn merged 2 commits into from
Sep 8, 2026
Merged

docs: add board product images to bilingual README #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9e2432
docs: add product gallery to bilingual readmes
Y1hsiaochunnn Sep 8, 2026
cd09c94
docs: refine board catalog layout
Y1hsiaochunnn Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,56 @@ bilingual documentation, and generation/build checks.

## 📋 Board catalog

<table>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.75C/6d19f7e16fb9a3be219e9eed43ca9eb56c88d01c/docs/images/esp32-s3-touch-amoled-1.75c.jpg" alt="ESP32-S3-Touch-AMOLED-1.75C development board" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-1.75C</strong></p>
<a href="boards/esp32_s3_touch_amoled_1_75c/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C">Product documentation</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.8/7ab8f957e22ea1ab811256359f4eddcaaf49ee91/assets/ESP32-S3-Touch-AMOLED-1.8-hero.webp" alt="ESP32-S3-Touch-AMOLED-1.8 development board" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-1.8</strong></p>
<a href="boards/esp32_s3_touch_amoled_1_8/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8">Product documentation</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-2.16/225a62bff11b5d0a0b607873860d39485a9a9685/docs/assets/ESP32-S3-Touch-AMOLED-2.16-details-1.jpg" alt="ESP32-S3-Touch-AMOLED-2.16 development board" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-2.16</strong></p>
<a href="boards/esp32_s3_touch_amoled_2_16/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16">Product documentation</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-LCD-7/bc51a84b30c0cea018fee6e0d7427ec10102060e/assets/Product-1.webp" alt="ESP32-S3-Touch-LCD-7 development board" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-LCD-7</strong></p>
<a href="boards/esp32_s3_touch_lcd_7/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7">Product documentation</a>
</td>
</tr>
</table>

<details>
<summary>Device and peripheral definitions</summary>

The table lists definitions present in this repository. Peripheral declarations
such as `spi_sd` describe a bus; they do not imply a complete storage application.

Expand All @@ -36,6 +86,8 @@ such as `spi_sd` describe a bus; they do not imply a complete storage applicatio
| [`esp32_s3_touch_lcd_7`](boards/esp32_s3_touch_lcd_7/) | ESP32-S3 | `display_lcd`, `lcd_touch` | `i2c_master`, `uart_rs485`, `uart_external`, `adc_sensor`, `spi_sd` |
<!-- END SUPPORTED_BOARDS -->

</details>

Definitions live under `boards/<full_model>/`. The three AMOLED profiles come
from Espressif Brookesia; see [board revisions and migration notes](docs/BOARDS.md).
CI validates generation and compilation; physical operation requires board testing.
Expand Down
52 changes: 52 additions & 0 deletions README_ZH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,56 @@

## 📋 板卡目录

<table>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.75C/6d19f7e16fb9a3be219e9eed43ca9eb56c88d01c/docs/images/esp32-s3-touch-amoled-1.75c.jpg" alt="ESP32-S3-Touch-AMOLED-1.75C 开发板产品图" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-1.75C</strong></p>
<a href="boards/esp32_s3_touch_amoled_1_75c/">板卡定义</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C">产品文档</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.8/7ab8f957e22ea1ab811256359f4eddcaaf49ee91/assets/ESP32-S3-Touch-AMOLED-1.8-hero.webp" alt="ESP32-S3-Touch-AMOLED-1.8 开发板产品图" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-1.8</strong></p>
<a href="boards/esp32_s3_touch_amoled_1_8/">板卡定义</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8">产品文档</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-2.16/225a62bff11b5d0a0b607873860d39485a9a9685/docs/assets/ESP32-S3-Touch-AMOLED-2.16-details-1.jpg" alt="ESP32-S3-Touch-AMOLED-2.16 开发板产品图" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-AMOLED-2.16</strong></p>
<a href="boards/esp32_s3_touch_amoled_2_16/">板卡定义</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16">产品文档</a>
</td>
</tr>
<tr>
<td align="center" valign="middle" width="180">
<a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7">
<img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-LCD-7/bc51a84b30c0cea018fee6e0d7427ec10102060e/assets/Product-1.webp" alt="ESP32-S3-Touch-LCD-7 开发板产品图" width="160">
</a>
</td>
<td valign="middle" width="600">
<p><strong>ESP32-S3-Touch-LCD-7</strong></p>
<a href="boards/esp32_s3_touch_lcd_7/">板卡定义</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7">产品文档</a>
</td>
</tr>
</table>

<details>
<summary>设备与外设定义</summary>

下表列出仓库中实际存在的定义。`spi_sd` 等外设声明描述的是总线，
不代表已经提供完整的存储应用。

Expand All @@ -35,6 +85,8 @@
| [`esp32_s3_touch_lcd_7`](boards/esp32_s3_touch_lcd_7/) | ESP32-S3 | `display_lcd`, `lcd_touch` | `i2c_master`, `uart_rs485`, `uart_external`, `adc_sensor`, `spi_sd` |
<!-- END SUPPORTED_BOARDS -->

</details>

板卡定义统一放在 `boards/<完整型号>/`。新增的三个 AMOLED 型号来自 Espressif Brookesia，
详见[硬件版本与迁移说明](docs/BOARDS_ZH.md)。CI 校验生成与编译，实机运行效果需要单独测试。

Expand Down
Loading