Skip to content

Commit ffa4447

Browse files
authored
Merge pull request drivercraft#20 from yueneiqi/doc
docs: add serial exit shortcut notes
2 parents 224cecf + 5a89721 commit ffa4447

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.en.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ ostool run uboot
128128
ostool run uboot --uboot-config my-uboot.toml
129129
```
130130

131+
> Exit shortcut: In the serial terminal (e.g., `ostool run uboot`), press `Ctrl+A` then `x` to quit; the tool captures this sequence and exits gracefully instead of sending it to the target device.
132+
> For more keyboard mappings, see `ostool/src/sterm/mod.rs`.
133+
131134
## ⚙️ Configuration Files
132135

133136
ostool uses multiple independent TOML configuration files, each responsible for different functional modules:
@@ -529,4 +532,4 @@ This project is dual-licensed:
529532

530533
## 🙏 Acknowledgments
531534

532-
Thanks to all developers and users who have contributed to the ostool project!
535+
Thanks to all developers and users who have contributed to the ostool project!

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ ostool run uboot
128128
ostool run uboot --uboot-config my-uboot.toml
129129
```
130130

131+
> 交互退出:在串口终端(如 `ostool run uboot`)中,按下 `Ctrl+A` 后再按 `x`,工具会检测到该序列并优雅退出,不会将按键发送到目标设备。
132+
> 更多键盘快捷键映射可参考源码 `ostool/src/sterm/mod.rs`
133+
131134
## ⚙️ 配置文件
132135

133136
ostool 使用多个独立的 TOML 配置文件,每个文件负责不同的功能模块:
@@ -528,4 +531,4 @@ cargo test
528531

529532
## 🙏 致谢
530533

531-
感谢所有为 ostool 项目做出贡献的开发者和用户!
534+
感谢所有为 ostool 项目做出贡献的开发者和用户!

0 commit comments

Comments
 (0)