docs: 更新文档

This commit is contained in:
2026-05-06 09:46:50 +08:00
parent cd23c2d773
commit 1caccc9114
2 changed files with 15 additions and 9 deletions

View File

@@ -46,11 +46,17 @@
- 性能提升: 得益于现代且支持分块的文件组织结构, 潜进能在保持高自由度的同时仅使用 python 就能达到敏捷且低占用的用户体验 - 性能提升: 得益于现代且支持分块的文件组织结构, 潜进能在保持高自由度的同时仅使用 python 就能达到敏捷且低占用的用户体验
- AI 友好: 想象您有一些 .apkg 牌组或一大段教材内容, 您可以方便且高效率地使用 AI 工具生成可在 HeurAMS 使用的单元集 - AI 友好: 想象您有一些 .apkg 牌组或一大段教材内容, 您可以方便且高效率地使用 AI 工具生成可在 HeurAMS 使用的单元集
### 实用用户界面 ### 内置实用用户界面
尽管内置界面不是唯一前端, 但它在多种场景下仍具有独特优势
- 响应式 Textual 框架构建的跨平台 TUI 界面 - 响应式 Textual 框架构建的跨平台 TUI 界面
- 支持触屏/鼠标/键盘多操作模式 - 支持触屏/鼠标/键盘多操作模式
- 简洁直观的复习流程设计 - 简洁直观的复习流程设计
- 与几乎所有现代终端模拟器相容
- 对于支持 sixel 的终端模拟器, 可支持显示图像内容
[查看屏幕截图](SCREENSHOTS.md)
## 快速开始 ## 快速开始

View File

@@ -2,8 +2,8 @@
潜进 (HeurAMS) 项目目前有两个前端实现, 此文档用于呈现它们的截图: 潜进 (HeurAMS) 项目目前有两个前端实现, 此文档用于呈现它们的截图:
- Textual (基本用户界面): 基于 Python Textual 框架构建的程序库内置跨平台 TUI 界面, 支持触屏、鼠标、键盘多操作模式, 是当前开箱即用的默认前端. - Textual 基本用户界面 (heurams.interface): 基于 Python Textual 框架构建的程序库内置跨平台 TUI 界面, 支持触屏、鼠标、键盘多操作模式, 是当前开箱即用的默认前端.
- KiriMemo: 基于 KDE `Kirigami` 框架的现代跨平台前端, 使用 C++ 和 QML 构建, 通过 `PyOtherSide` 直接复用 Python 内核,为 Windows、Linux、macOS、Android、iOS 和 Plasma Mobile 提供原生体验(尚未稳定). - KiriMemo (org.kde.kirimemo): 基于 KDE Kirigami 框架的现代跨平台前端, 使用 C++ 和 QML 构建, 通过 `PyOtherSide` 直接复用 Python 内核, 为多种平台提供原生体验 (尚未稳定).
欢迎为现有前端贡献代码, 或开发您自己的前端. 欢迎为现有前端贡献代码, 或开发您自己的前端.
详见[贡献指南](CONTRIBUTING.md#新的用户界面前端). 详见[贡献指南](CONTRIBUTING.md#新的用户界面前端).
@@ -23,8 +23,8 @@
### 准备界面与预缓存工具 ### 准备界面与预缓存工具
学习准备界面展示了单元集基本信息和每个单元的学习状态, 并提供了学习和预缓存的入口. 学习准备界面展示了单元集基本信息和每个单元的学习状态, 并提供了学习和预缓存的入口.
预缓存工具使您能提前预缓存文本转语音资源以确保复习流程的顺畅体验和离线复习能力, 但即使您不预先缓存, 资源也会在复习播放时被自动加载. 预缓存工具使您能提前预缓存文本转语音资源以确保复习流程的顺畅体验和离线复习能力, 但即使您不预先缓存, 资源也会在复习播放时被自动加载.
<div style="display: flex; flex-wrap: wrap; gap: 10px;"> <div style="display: flex; flex-wrap: wrap; gap: 10px;">
<img src="screenshots/preparation.png" width="48%"> <img src="screenshots/preparation.png" width="48%">
@@ -34,7 +34,7 @@
### 记忆队列界面 ### 记忆队列界面
队列式学习记忆的主要界面. 队列式学习记忆的主要界面.
同一知识点可产生多种谜题类型的评估方式, 软件内置完形填空与识别题等多种测试类型, 您可在复习流程中按顺序完成不同测试. 同一知识点可产生多种谜题类型的评估方式, 软件内置完形填空与识别题等多种测试类型, 您可在复习流程中按顺序完成不同测试.
<div style="display: flex; flex-wrap: wrap; gap: 10px;"> <div style="display: flex; flex-wrap: wrap; gap: 10px;">
<img src="screenshots/memoqueue_cloze_1.png" width="48%"> <img src="screenshots/memoqueue_cloze_1.png" width="48%">
@@ -43,9 +43,9 @@
</div> </div>
### 设置 ### 设置界面
配置界面包含算法选择、音频与多种服务的提供者切换、以及界面与算法设置等选项. 配置界面包含算法选择、音频与多种服务的提供者切换、以及界面与算法设置等选项.
<div style="display: flex; flex-wrap: wrap; gap: 10px;"> <div style="display: flex; flex-wrap: wrap; gap: 10px;">
<img src="screenshots/setting_1.png" width="48%"> <img src="screenshots/setting_1.png" width="48%">
@@ -64,5 +64,5 @@
## KiriMemo 前端的截图 ## KiriMemo 前端的截图
截图将在 KiriMemo 前端开发趋于稳定后补充. 截图将在 KiriMemo 前端开发趋于稳定后补充.
<!-- TODO: 补充截图 --> <!-- TODO: 补充截图 -->