Skip to content

README.md

Latest commit

 

History

History
76 lines (58 loc) · 3.65 KB

README.md

File metadata and controls

76 lines (58 loc) · 3.65 KB
Raw

Documentation

User guide  ·  使用指南  ·  使用指南  ·  ユーザーガイド

GitHub README · Troubleshooting · Changelog · 更新记录

User-facing manuals for IGP Performance Monitor. Pick a language, then open the page you need.

The same guide is in the app: Help → User Manual. The packaged EXE and the installer both include this docs/ tree. The UI locale (en / zh_CN) picks en/ or zh-CN/; zh-TW and ja stay readable here and via in-manual language links.

界面语言目前只有英语和简体中文（IGP_LANG=en 或 zh_CN）。文档比界面多两种语言，方便阅读。

Contributor / agent notes stay in English at the repo root: CLAUDE.md, CONTRIBUTING.md, and .claude/skills/.

Languages

Language README User guide Troubleshooting
English README User guide Troubleshooting
简体中文 README 使用指南 排障
繁體中文 README 使用指南 疑難排解
日本語 README ユーザーガイド トラブルシューティング

English is the canonical copy. Other locales follow the same headings so they stay in sync.

What each page covers

Page Audience Contents
README.md Anyone landing on the project What the app is, install assets, features, run-from-source, license
user-guide.md People using the packaged app First capture, window, charts, overlay, CSV, updates, shortcuts, CLI, metric glossary (screenshots in docs/images/)
troubleshooting.md When something fails Admin / ETW, no frames, GPU, overlay, language, updates

Directory

docs/
  README.md                 This index
  en/                       English (canonical)
  zh-CN/                    Simplified Chinese
  zh-TW/                    Traditional Chinese
  ja/                       Japanese

Folder names are BCP 47 language tags. Each locale uses the same three filenames.

To add a language: copy en/, translate, and add a row to the table above plus language links at the top of every README.

GitHub landing READMEs (repo root and docs/<locale>/README.md) keep documentation visible: a centered <strong> action row (Download / User guide / 使用指南 / …) plus a Documentation section. Do not put the user-guide link on the same thin · line as the language switcher — that row is easy to miss. Keep all four locale READMEs on the same layout.

Related repo files (not localized)

File Role
README.md GitHub landing page (English)
CHANGELOG.md English release notes (Help → Changelog, GitHub Releases)
CHANGELOG.zh-CN.md Simplified Chinese release notes (same versions, same detail)
CONTRIBUTING.md How to change src/
SECURITY.md Vulnerability reporting
THIRD_PARTY_NOTICES.md PresentMon / Qt licenses