Files

T

Redredchen01 e32e0df209 Make Chinese README primary; ship English as README.en.md

Restructure docs so README.md is full Chinese documentation with TOC.
English content moves to README.en.md; drop README.zh-CN.md. Align
CONTRIBUTING, install script, package/plugin descriptions, and skill links.

2026-07-17 16:32:20 +08:00

1.1 KiB

Raw Blame History

贡献指南

English notes: keep commit messages in English. Primary docs are Chinese (README.md); English summary: README.en.md.

环境

git clone http://172.238.15.154:3000/Redredchen01/grok-hud.git
cd grok-hud
npm install
npm test

目录结构

路径	作用
`src/`	TypeScript 源码（session、billing、status、tmux、theme、CLI）
`bin/`	入口：`grok-build-hud`、`grok-hud`、`grok-hud-run`、hook
`tests/`	Node 内置测试 (`node --test`)
`fixtures/`	测试用 session / billing 样例
`commands/` / `skills/`	Grok 插件表面
`scripts/install.sh`	一键安装
`README.md`	中文主文档
`README.en.md`	英文简版

约定

优先读本机 ~/.grok/sessions/**，不臆造 API
配额接口离线 / 未登录时优雅降级（渲染路径不抛错）
HUD 保持同窗口（tmux status），默认不另开 Terminal
改解析 / 渲染逻辑请补测试
Commit message 用英文；用户文档以中文为主

提交前

npm test

全部测试通过后再 push。

1.1 KiB Raw Blame History Unescape Escape

贡献指南

环境

目录结构

约定

提交前

1.1 KiB

Raw Blame History