From 39794e7f282258cc0b026f69357713c7dfded4dd Mon Sep 17 00:00:00 2001 From: crispyberry Date: Sat, 7 Feb 2026 23:09:40 +0800 Subject: [PATCH] docs: update build/flash instructions with fullclean and port detection Co-Authored-By: Claude Opus 4.6 --- README.md | 14 ++++++++++---- README_CN.md | 14 ++++++++++---- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2fdea20..c965079 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,17 @@ Edit `main/mimi_secrets.h`: Then build and flash: ```bash -idf.py build -idf.py -p /dev/ttyACM0 flash monitor -``` +# Clean build (required after any mimi_secrets.h change) +idf.py fullclean && idf.py build -> **Important:** After editing `mimi_secrets.h`, you must do a full rebuild: `idf.py fullclean && idf.py build` +# Find your serial port +ls /dev/cu.usb* # macOS +ls /dev/ttyACM* # Linux + +# Flash and monitor (replace PORT with your port) +# USB adapter: likely /dev/cu.usbmodem11401 (macOS) or /dev/ttyACM0 (Linux) +idf.py -p PORT flash monitor +``` ### CLI Commands diff --git a/README_CN.md b/README_CN.md index 1f210f5..5913503 100644 --- a/README_CN.md +++ b/README_CN.md @@ -87,11 +87,17 @@ cp main/mimi_secrets.h.example main/mimi_secrets.h 然后编译烧录: ```bash -idf.py build -idf.py -p /dev/ttyACM0 flash monitor -``` +# 完整编译(修改 mimi_secrets.h 后必须 fullclean) +idf.py fullclean && idf.py build -> **重要**:修改 `mimi_secrets.h` 后必须完整重编译:`idf.py fullclean && idf.py build` +# 查找串口 +ls /dev/cu.usb* # macOS +ls /dev/ttyACM* # Linux + +# 烧录并监控(将 PORT 替换为你的串口) +# USB 转接器:大概率是 /dev/cu.usbmodem11401(macOS)或 /dev/ttyACM0(Linux) +idf.py -p PORT flash monitor +``` ### 代理配置(国内用户)