@qnroa/qtype 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+Chinese: [CHANGELOG.zh.md](./CHANGELOG.zh.md)
+
+All notable changes to this project are documented in this file.
+
+The format is loosely based on [Keep a Changelog][keep], and this project
+adheres to [Semantic Versioning][semver]. Pre-1.0 means breaking changes
+can land in any minor bump (`0.x.0`).
+
+[keep]: https://keepachangelog.com/en/1.1.0/
+[semver]: https://semver.org/spec/v2.0.0.html
+
+## [Unreleased]
+
+## [0.0.1] - 2026-08-16
+
+Initial development release. Everything below is the baseline shipped
+with this version.
+
+### Added
+
+- **CLI baseline** — mirrors qrism's `registry / mount / bootstrap`
+  pattern one-for-one:
+  - `qtype init [dir]` — alias for `repo sync`, creates the material
+    scaffold in an existing directory
+  - `qtype repo new <name>` / `qtype repo sync [dir]` — scaffold or
+    top-up a repo (spec + AGENTS/CLAUDE/GEMINI symlinks + `.qtype/`
+    skeleton + example material)
+  - `qtype check [dir]` — validate material files, reports cards with
+    non-typable characters; non-zero exit on failure
+  - `qtype publish build` — assemble the static site into `dist/`
+    (per-material page + pre-rendered mermaid + optional password gate)
+  - `qtype publish serve` — local HTTP preview
+  - `qtype publish init` — write `.gitignore` + GitHub Pages workflow
+  - `qtype publish password set/clear/status` — password protection
+    lifecycle
+  - `qtype pack [-o file]` — bundle the whole material repo into a
+    `tar.gz`
+  - `qtype content lint / validate / search` — content-oriented lint
+    passes and plain-substring search
+  - `qtype config get/set/unset/list` — git-style two-layer config
+    (user + repo), driven by the store layer with strict-schema mode
+  - `qtype plugin` — command skeleton (no plugin execution yet)
+
+- **Core layer** (`src/core/`) — pure logic, IO-free at the edges:
+  - `parser/parseMaterial` — `## Q:` / `## A:` cards with `\n\n---\n\n`
+    separators, YAML frontmatter (tags / type / hint / difficulty /
+    phonetic / gloss / translation)
+  - `typing/` — `TypingEngine` state machine + WPM/accuracy metrics
+  - `keystroke/` — key event normalisation
+  - `srs/` — spaced-repetition scaffolding
+  - `encrypt.ts` — AES-256-GCM helpers used by `publish password`
+
+- **Store layer** (`src/store/`) — `KvStore` on top of a `Storage`
+  interface (`JsonStorage` / `BrowserStorage` / `MemoryStorage`).
+  Prototype-pollution safe (`__proto__` / `constructor` / `prototype`
+  segments are rejected). Includes an i18n-friendly `KvError` with
+  structured `code` + `vars`.
+
+- **View SPA** (`src/view/`) — React 18 + TanStack Router. Features:
+  - Typing arena with progress + WPM/accuracy panel
+  - Material list + tag/type filters
+  - Command palette (⌘K style)
+  - Bilingual UI (`zh` / `en`)
+  - Password gate (AES-256-GCM decryption of encrypted materials, key
+    derived via Argon2id from the plaintext password)
+  - Mermaid diagram rendering (pre-baked SVGs from `publish build` or
+    client-side fallback)
+
+- **Templates** — bilingual `templates/{zh,en}/` with `QTYPE.md`
+  authoring spec, sample `README.md` / `TODO.md` / `index.md` /
+  `log.md`, and an example `material/example.md`. Copied verbatim into
+  every new repo by `qtype init` / `qtype repo new`.
+
+- **i18n** — CLI messages and view UI both bilingual. Language
+  resolved from `--lang` > `$QTYPE_LANG` > `cli.lang` config >
+  fallback.
+
+- **Docs + testing scaffold** — this initial cut of `README.md` /
+  `CONTRIBUTING.md` / `TODO.md` / `docs/` / `__tests__/` matches
+  qrism's shape, so contributors coming from qrism find the same
+  layout.
+
+### Known limitations
+
+- View-side password UI is functional but rough; polish pending
+- `TypingArena` doesn't yet accept an injected `engine: TypingEngine`
+  prop (the `useTypingEngine` hook exists but the arena manages its
+  own state)
+- Icons are still defined inline in components; not yet extracted to
+  `components/icons/`
+- `content search` is plain substring — no tag / type filters
+- Welcome feature is a skeleton
+- E2E automation is minimal
+
+See [TODO.md](./TODO.md) for the tracked backlog.

package/CHANGELOG.zh.md

@@ -0,0 +1,82 @@
+# 变更记录
+
+English: [CHANGELOG.md](./CHANGELOG.md)
+
+本文件记录本项目的所有值得注意的变更。
+
+格式大致沿用 [Keep a Changelog][keep]，版本号遵循 [语义化版本][semver]。
+1.0 之前，破坏性变更可能落在任意 minor 版本（`0.x.0`）里。
+
+[keep]: https://keepachangelog.com/zh-CN/1.1.0/
+[semver]: https://semver.org/lang/zh-CN/
+
+## [Unreleased]
+
+## [0.0.1] - 2026-08-16
+
+首个开发版。以下是这个版本的基线内容。
+
+### 新增
+
+- **CLI 基线** —— `registry / mount / bootstrap` 模式一比一镜像 qrism：
+  - `qtype init [dir]` —— `repo sync` 的别名，在已有目录中补齐资料脚手架
+  - `qtype repo new <name>` / `qtype repo sync [dir]` —— 新建仓库或补齐
+    约定文件（规范 + AGENTS/CLAUDE/GEMINI 软链 + `.qtype/` 骨架 + 示例 material）
+  - `qtype check [dir]` —— 校验 material 文件，报告含无法打字字符的卡片，
+    失败时以非零码退出
+  - `qtype publish build` —— 拼装静态站到 `dist/`（每份 material 一页 +
+    预渲染 mermaid + 可选密码门）
+  - `qtype publish serve` —— 本地 HTTP 预览
+  - `qtype publish init` —— 写 `.gitignore` + GitHub Pages workflow
+  - `qtype publish password set/clear/status` —— 密码保护生命周期
+  - `qtype pack [-o file]` —— 打包整个 material 仓库为 `tar.gz`
+  - `qtype content lint / validate / search` —— 内容维度的 lint 通道
+    与纯子串搜索
+  - `qtype config get/set/unset/list` —— git 风格的双层配置（user +
+    repo），由 store 层驱动，配严格 schema 模式
+  - `qtype plugin` —— 命令骨架（尚未执行插件）
+
+- **核心层**（`src/core/`）—— 边界之外无 IO 的纯逻辑：
+  - `parser/parseMaterial` —— `## Q:` / `## A:` 卡片，`\n\n---\n\n`
+    分隔，YAML frontmatter（tags / type / hint / difficulty /
+    phonetic / gloss / translation）
+  - `typing/` —— `TypingEngine` 状态机 + WPM / 准确率指标
+  - `keystroke/` —— 按键事件归一化
+  - `srs/` —— 间隔复习脚手架
+  - `encrypt.ts` —— `publish password` 使用的 AES-256-GCM 助手
+
+- **存储层**（`src/store/`）—— 建立在 `Storage` 接口上的 `KvStore`
+  （`JsonStorage` / `BrowserStorage` / `MemoryStorage`）。原型链污染安全
+  （拒绝 `__proto__` / `constructor` / `prototype` 段）。带 i18n 友好的
+  `KvError`，携带结构化 `code` + `vars`。
+
+- **View SPA**（`src/view/`）—— React 18 + TanStack Router。特性：
+  - 打字场地 + 进度 + WPM / 准确率面板
+  - 材料列表 + tag / type 过滤
+  - 命令面板（⌘K 风格）
+  - 双语 UI（`zh` / `en`）
+  - 密码门（AES-256-GCM 解密加密后的 material，密钥经 Argon2id 从明文密码派生）
+  - Mermaid 图渲染（`publish build` 预烘焙 SVG，或 client 端兜底）
+
+- **模板** —— 双语 `templates/{zh,en}/`，含 `QTYPE.md` 撰写规范、示例
+  `README.md` / `TODO.md` / `index.md` / `log.md`，以及一个示例
+  `material/example.md`。`qtype init` / `qtype repo new` 时逐字拷贝到新仓库。
+
+- **i18n** —— CLI 消息和 view UI 都双语。语言来源优先级：`--lang` >
+  `$QTYPE_LANG` > `cli.lang` 配置 > 默认。
+
+- **文档 + 测试脚手架** —— 首版 `README.md` / `CONTRIBUTING.md` /
+  `TODO.md` / `docs/` / `__tests__/` 都对齐 qrism 的形态，让从 qrism
+  过来的贡献者能立刻上手。
+
+### 已知限制
+
+- View 端密码 UI 可用但粗糙，待打磨
+- `TypingArena` 还没接受注入式 `engine: TypingEngine` prop（`useTypingEngine`
+  钩子已存在但 arena 自己管着状态）
+- 图标还是在组件里内联定义，尚未抽到 `components/icons/`
+- `content search` 是纯子串匹配 —— 没有 tag / type 过滤
+- Welcome 特性只是骨架
+- E2E 自动化很少
+
+追踪清单见 [TODO.zh.md](./TODO.zh.md)。

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,113 @@
+# qtype
+
+**English** | [中文](./README.zh.md)
+
+**Markdown-driven typing review / practice tool.** Write a `## Q:` / `## A:` card, and qtype makes you **type the answer** to review it.
+
+qtype is the sister project of [qrism](https://github.com/qnroa/qrism): qrism focuses on **graph-navigated knowledge reading**, qtype focuses on **active typing to internalise knowledge**. Both share the same "MD is the single source of truth" value.
+
+## Quick start
+
+```bash
+# One-time
+npm install -g @qnroa/qtype
+
+# Or run directly via npx
+npx @qnroa/qtype init my-deck
+cd my-deck
+# Author your material/*.md files (see QTYPE.md)
+npx @qnroa/qtype publish build
+npx @qnroa/qtype publish serve    # http://localhost:4000
+```
+
+Requires Node ≥ 20.
+
+## CLI
+
+| Command | What it does |
+|---|---|
+| `qtype init [dir]` | Scaffold a material repo (with `QTYPE.md` spec + AGENTS/CLAUDE/GEMINI symlinks) |
+| `qtype check [dir]` | Validate card format (read-only) |
+| `qtype publish build` | Assemble the static site into `dist/` |
+| `qtype publish serve` | Local preview |
+| `qtype publish init` | Write `.gitignore` + GitHub Pages workflow |
+| `qtype pack` | Bundle the material repo into `.tar.gz` |
+| `qtype config` | Get / set / unset / list settings (user + repo layers) |
+| `qtype repo new / sync` | Create a new repo / fill in conventions |
+
+Run `qtype <cmd> --help` for full options.
+
+## Card format
+
+A single card:
+
+```markdown
+---
+tags: [js, basics]
+type: normal
+---
+
+## Q:
+
+What are the three core concepts of React?
+
+## A:
+
+Components, props, and state.
+```
+
+Multiple cards in one file are separated by `\n\n---\n\n` (on its own line).
+
+Supported types: `normal | word | sentence`. `word` / `sentence` cards may carry `phonetic` / `gloss` / `translation`. Full spec lives in `templates/{zh,en}/QTYPE.md` (copied into your repo by `qtype init`).
+
+## Naming
+
+- `qrism = Q + prism` — the prism of questions, refracting MD into an explorable knowledge graph.
+- `qtype = Q + type` — typing your way through questions, turning MD into typable cards.
+
+## Documentation
+
+- [Architecture](./docs/en/architecture.md) — how `core` / `cli` / `view` relate
+- [CLI reference](./docs/en/cli-reference.md) — brief overview of every command
+- [Authoring guide](./docs/en/authoring.md) — quick primer on writing `material/*.md`
+- [`CONTRIBUTING.md`](./CONTRIBUTING.md) — dev setup + PR flow
+- [`CHANGELOG.md`](./CHANGELOG.md) — release history
+
+Full authoring spec: [`templates/en/QTYPE.md`](./templates/en/QTYPE.md) / [`templates/zh/QTYPE.md`](./templates/zh/QTYPE.md). Copied into every new repo as `QTYPE.md` based on `qtype init --lang zh|en`.
+
+## Development
+
+```bash
+npm install
+npm run dev:view         # http://localhost:5173 (view hot dev)
+npm test                 # vitest
+npm run build            # build:cli + build:view
+npm run lint             # tsc --noEmit (cli + view tsconfigs)
+```
+
+## Repo layout
+
+```
+qtype/
+├── src/
+│   ├── core/       # pure logic, no IO (parser / typing / keystroke / ...)
+│   ├── view/       # React SPA
+│   ├── store/      # persistence (KvStore + JsonStorage / MemoryStorage / BrowserStorage)
+│   └── cli/        # commander + registry/mount pattern
+├── templates/{zh,en}/    # copied into user repo by init
+├── tsconfig.{cli,view}.json
+└── vite.config.ts        # outputs to dist/view
+```
+
+Publish structure:
+- `dist/cli/` — CLI executable (`bin: qtype`)
+- `dist/core/` — re-usable for external APIs (`exports "./core"`)
+- `dist/view/` — pre-built SPA; `publish build` copies this into user `dist/`
+
+## Relationship to qrism
+
+The CLI structure (registry / mount / i18n / bootstrap) mirrors qrism almost one-for-one. QTYPE.md is the counterpart of QRISM.md — an LLM-authoring spec for structured Markdown. The only real difference is that qtype cards are "meant to be typed" while qrism nodes are "meant to be read".
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).

package/README.zh.md

@@ -0,0 +1,114 @@
+# qtype
+
+[English](./README.md) | **中文**
+
+**Markdown 驱动的打字复习/练习工具。** 写一份 `## Q:` / `## A:` 卡片，qtype 让你把答案**打一遍**来复习。
+
+qtype 是 [qrism](https://github.com/qnroa/qrism) 的姊妹项目：qrism 关注**图导航的知识阅读**，qtype 关注**主动打字的知识内化**。共享同一个"MD 是唯一真相源"的价值观。
+
+## 快速开始
+
+```bash
+# 一次性
+npm install -g @qnroa/qtype
+
+# 或直接 npx
+npx @qnroa/qtype init my-deck
+cd my-deck
+# 用你的编辑器/AI 助手写 material/*.md（详见 QTYPE.md）
+npx @qnroa/qtype publish build
+npx @qnroa/qtype publish serve    # http://localhost:4000
+```
+
+需要 Node ≥ 20。
+
+## CLI
+
+| 命令 | 作用 |
+|---|---|
+| `qtype init [dir]` | 初始化资料仓库（含 QTYPE.md 规范 + AGENTS/CLAUDE/GEMINI 软链） |
+| `qtype check [dir]` | 校验卡片格式，只读 |
+| `qtype publish build` | 拼装静态站到 `dist/` |
+| `qtype publish serve` | 本地预览 |
+| `qtype publish init` | 写 `.gitignore` + GitHub Pages workflow |
+| `qtype pack` | 打包整个资料为 `.tar.gz` |
+| `qtype config` | 读 / 写 / 删 / 列配置（user + repo 双层） |
+| `qtype repo new / sync` | 新建仓库 / 补齐约定 |
+
+每个命令 `qtype <cmd> --help` 看完整选项。
+
+## 卡片格式
+
+一张卡：
+
+```markdown
+---
+tags: [js, basics]
+type: normal
+---
+
+## Q:
+
+React 三大核心概念是什么？
+
+## A:
+
+组件、props 和 state。
+```
+
+一份 MD 里多张卡片用 `\n\n---\n\n`（独占行）分隔。
+
+支持 `type: normal | word | sentence`，`word` / `sentence` 可带 `phonetic` / `gloss` / `translation`。完整规范见 `templates/{zh,en}/QTYPE.md`（由 `qtype init` 复制到你的仓库）。
+
+## 命名
+
+- `qrism = Q + prism`（问题的棱镜）—— 把 MD 折射成可探索的知识图。
+- `qtype = Q + type`（问题的打字）—— 把 MD 转成可打字复现的卡片。
+
+## 文档
+
+- [架构总览](./docs/zh/architecture.md) —— `core` / `cli` / `view` 怎么分工
+- [CLI 简介](./docs/zh/cli-reference.md) —— 每个命令的简单说明
+- [撰写指南](./docs/zh/authoring.md) —— `material/*.md` 的快速入门
+- [`CONTRIBUTING.zh.md`](./CONTRIBUTING.zh.md) —— 开发环境 + PR 流程
+- [`CHANGELOG.zh.md`](./CHANGELOG.zh.md) —— 版本历史
+
+规范全文：[`templates/en/QTYPE.md`](./templates/en/QTYPE.md) /
+[`templates/zh/QTYPE.md`](./templates/zh/QTYPE.md)。`qtype init --lang zh|en` 时拷成用户仓库的 `QTYPE.md`。
+
+## 开发
+
+```bash
+npm install
+npm run dev:view         # http://localhost:5173（view 端热开发）
+npm test                 # vitest
+npm run build            # build:cli + build:view
+npm run lint             # tsc --noEmit（cli + view 两份 tsconfig）
+```
+
+## 目录结构
+
+```
+qtype/
+├── src/
+│   ├── core/       # 纯逻辑，无 IO（parser / typing / keystroke / ...）
+│   ├── view/       # React SPA
+│   ├── store/      # 持久化（KvStore + JsonStorage / MemoryStorage / BrowserStorage）
+│   └── cli/        # commander + registry/mount 模式
+├── templates/{zh,en}/    # init 时复制到用户仓库
+├── tsconfig.{cli,view}.json
+└── vite.config.ts        # 输出到 dist/view
+```
+
+发布结构：
+- `dist/cli/` — CLI 可执行文件（`bin: qtype`）
+- `dist/core/` — 复用给外部 API（`exports "./core"`）
+- `dist/view/` — 预编译的 SPA，`publish build` 拷贝这里到用户 `dist/`
+
+## 与 qrism 的关系
+
+CLI 结构（registry / mount / i18n / bootstrap）几乎一比一镜像 qrism。QTYPE.md 对应 QRISM.md —— 一份让 LLM 生成结构化 Markdown 的规范。区别只在于 qtype 的卡片是"要被打字重现的"，而 qrism 的节点是"要被阅读的"。
+
+## License
+
+Apache-2.0 —— 详见 [LICENSE](./LICENSE)。