Skip to content

emrg: docs — README 重写为 GUI 第一(GUI 主入口 + 首次配置引导) - #484

Merged
argszero merged 1 commit into
masterfrom
feature/readme-gui-first
Aug 6, 2026
Merged

emrg: docs — README 重写为 GUI 第一(GUI 主入口 + 首次配置引导)#484
argszero merged 1 commit into
masterfrom
feature/readme-gui-first

Conversation

@argszero

@argszero argszero commented Aug 6, 2026

Copy link
Copy Markdown
Owner

背景

EMRG 已有成熟 Electron GUI(v0.2.5 重设计 / v0.2.7 macOS 签名公证),但 README 快速开始仍以终端为中心(引导 vim 编辑 config.toml、"不想用终端?"补充式表达)。宿主要求:GUI 是主入口,安装和配置都通过 GUI;GUI 配好即 TUI 可用(rant 2026-08-06T19:32:27)。

改动(README.md + README.en.md 双语同步)

  1. 特性表:GUI 提到第一位,标注"主入口",明确"GUI 配好即 TUI 可用(配置共享)"
  2. 快速开始:下载表格后改为"三步开始使用"——打开 GUI → 首次启动引导配置 API Key/模型 → 开始对话(TUI 同步可用)
  3. 新增"首次配置(GUI 第一)":GUI 引导配置 API Key/接口地址/模型,配置写入 ~/.emrg/config.toml 与 TUI 共享
  4. 删除"vim 编辑 config.toml"首次配置引导:改为"高级配置(可选)"——GUI 保存会重写 config,高级用户才直接编辑文件
  5. 删除"不想用终端?"补充式表达:GUI 就是主入口(不再建议 git clone + npm start)
  6. 命令一览:加注"GUI 覆盖大部分日常操作;TUI 提供 /rant /model /memory 等进阶命令"
  7. 吸收 emrg: docs — README 补充 Windows SmartScreen 放行说明 #482(已关闭):保留 Windows SmartScreen 放行说明(下载表格 + FAQ"未知发布者"条目)——rant 19:32 验收明确要求保留

验证

  • 中英双语对应;GUI 路径清晰(下载 → 安装 → 打开 GUI → 引导配置 → 开始用)
  • 明确"GUI 配置完成后 TUI 直接用 emrg 进入,无需重复配置"
  • 无 vim 首次配置引导残留;SmartScreen 说明完整保留
  • pytest 473 passed + import OK

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle 1940

自查:README.md/README.en.md GUI 第一重写完成——特性表 GUI 首位、三步开始(GUI→引导→对话)、首次配置 GUI 优先、删除 vim 首次引导与'不想用终端'、命令一览注明 GUI 覆盖日常;吸收 #482 的 SmartScreen 说明(下载表格 + FAQ,rant 19:23 验收保留)。中英对应,pytest 473 passed。

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle 200725

Independent verification: README.md/README.en.md rewritten GUI-first — feature table lists Electron GUI as main entry, three-step start (GUI → wizard → chat), GUI-first first-time config, TUI advanced-command section, SmartScreen guidance absorbed from #482 (download table + FAQ, rant 19:23 acceptance preserved). Chinese/English versions correspond. Docs-only change, no code logic. LGTM.

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle 20260806-202237

Verified:

  1. GUI-first restructure matches host requirement (rant 19:32): GUI as main entry, three-step start, config shared GUI↔TUI
  2. Feature table reordered correctly (GUI first), TUI described as advanced entry
  3. SmartScreen FAQ accurate: Windows unsigned (no Authenticode), macOS signed+notarized v0.2.7 — matches actual build state
  4. MIT license mention consistent with LICENSE file
  5. ZH/EN versions in sync (both +70/-42)

@argszero
argszero merged commit 1e55701 into master Aug 6, 2026
1 check passed
argszero added a commit that referenced this pull request Aug 6, 2026
Version bump 0.2.7 → 0.2.8 across all 6 version sources
(pyproject.toml / emrg/__init__.py / make-installer.sh /
build-runtime.sh / gui/package.json / uv.lock). Release includes
#486/#487/#491 GUI slash commands P1-P3, #488/#492/#493 i18n prompts,
#489/#490 evolution workspace self-heal, #484/#485 README/language
policy, #483 docs cleanup. test_version_sync all green.

Co-authored-by: EMRG Evolution <emrg@argszero.dev>
@argszero
argszero deleted the feature/readme-gui-first branch August 6, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant