Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -168,11 +168,13 @@ jobs:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh release upload "v$VERSION" artifacts/release-*/SHA256SUMS-*.txt --clobber
# The user manuals (built with docs/manual/build/build.ps1 and committed) are
# downloadable next to the installers.
# The English and Traditional Chinese user manuals (built with
# docs/manual/build/build.ps1 and committed) are downloadable next to the installers.
# The other languages are only in docs/manual.
- name: User manuals
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
ls docs/manual/QRcode-tool-User-Manual-*.pdf docs/manual/QRcode-tool-User-Manual-*.docx
gh release upload "v$VERSION" docs/manual/QRcode-tool-User-Manual-*.pdf docs/manual/QRcode-tool-User-Manual-*.docx --clobber
files="docs/manual/QRcode-tool-User-Manual-en.pdf docs/manual/QRcode-tool-User-Manual-en.docx docs/manual/QRcode-tool-User-Manual-zh-TW.pdf docs/manual/QRcode-tool-User-Manual-zh-TW.docx"
ls $files
gh release upload "v$VERSION" $files --clobber
15 changes: 9 additions & 6 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,13 @@ triggered from one of their own callbacks.

## User manual

`docs/manual` holds the user manual (PDF + Word, English and Traditional Chinese). Its text is in
`docs/manual/build/content.*.js`; the screenshots are rendered from the real `.slint` files. When a
visible feature or window changes, update the text and rebuild with
`docs/manual/build/build.ps1` (Windows, Node.js, Microsoft Word). The release workflow attaches
the committed `.pdf`/`.docx` files to every GitHub release.
`docs/manual` holds the user manual (PDF + Word) in all ten UI languages. Its text is in
`docs/manual/build/content.<lang>.js`; the screenshots are rendered from the real `.slint` files.
When a visible feature or window changes, update the text in every language and rebuild with
`docs/manual/build/build.ps1` (Windows, Node.js, Microsoft Word; `-Langs ja,ko` limits the
languages). The release workflow attaches only the English and Traditional Chinese
`.pdf`/`.docx` files to every GitHub release. The READMEs in `docs/i18n` follow the English
`README.md`; keep their language links in sync.

**Screenshots are stored in `docs/manual/screenshots/<lang>/<name>.png`.** That folder is
git-ignored: never commit or push it. `build.ps1` reuses these files and only takes the missing
Expand All @@ -88,7 +90,8 @@ powershell -ExecutionPolicy Bypass -File docs\manual\build\build.ps1 -Shots tool
```

`-Shots all` retakes everything (needed on a fresh checkout or after changing `Theme`/widgets
used everywhere); `-SkipShots` only rebuilds the documents. Retaking `desktop` also retakes the
used everywhere); `-SkipShots` only rebuilds the documents. Texts of the mock desktop and menus
in the screenshots are in `docs/manual/build/docscenes/strings.<lang>.json`. Retaking `desktop` also retakes the
scan and detail screenshots drawn on it, and `camera-source` retakes `camera`. Names (defined in
`NAMES` in `docs/manual/build/shoot.js`, cropped in `figures.js`):

Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- README and user manual (PDF and Word) in Simplified Chinese, Spanish, Portuguese (Brazil), Japanese, Korean, French, German and Russian, in `docs/i18n` and `docs/manual`. Release downloads still carry only the English and Traditional Chinese manuals.

### Changed

- The **?** button on the floating toolbar opens the manual in the language of the UI.

## [1.0.1] - 2026-10-15

### Changed
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
![Languages](https://img.shields.io/badge/languages-10-informational)
![Privacy](https://img.shields.io/badge/privacy-no%20telemetry-success)

· **English** · [繁體中文](docs/i18n/README.zh-TW.md) ·
· **English** · [繁體中文](docs/i18n/README.zh-TW.md) · [简体中文](docs/i18n/README.zh-CN.md) · [Español](docs/i18n/README.es.md) · [Português (Brasil)](docs/i18n/README.pt-BR.md) · [日本語](docs/i18n/README.ja.md) · [한국어](docs/i18n/README.ko.md) · [Français](docs/i18n/README.fr.md) · [Deutsch](docs/i18n/README.de.md) · [Русский](docs/i18n/README.ru.md) ·

Press a shortcut → every QR code on your screen gets a label → press Enter.

Works with your webcam too. Free, open source and private.

📘 **User manual:** [PDF](docs/manual/QRcode-tool-User-Manual-en.pdf) · [.docx](docs/manual/QRcode-tool-User-Manual-en.docx) — also attached to every [release](https://github.com/naritaroad/qrcode-tool/releases/latest).
📘 **User manual:** [PDF](docs/manual/QRcode-tool-User-Manual-en.pdf) · [.docx](docs/manual/QRcode-tool-User-Manual-en.docx) — also attached to every [release](https://github.com/naritaroad/qrcode-tool/releases/latest). Other languages are in [docs/manual](docs/manual/README.md).

![Screen scan: every code on the screen gets a pill with its site name](docs/assets/screen-scan.png)

Expand Down Expand Up @@ -201,7 +201,7 @@ qrcode-tool/
├─ assets/icons/ # App and tray icons
├─ packaging/ # MSIX, Linux desktop entry, macOS bundle info
├─ docs/ # Architecture, building, FAQ, privacy, translations
│ └─ manual/ # User manual (PDF + Word, English and 繁體中文) and its build scripts
│ └─ manual/ # User manual (PDF + Word, 10 languages) and its build scripts
└─ .github/workflows/ # CI and release pipeline
```

Expand Down
14 changes: 10 additions & 4 deletions crates/qrtool-core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,13 @@ pub mod app_info {
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// The PDF user manual in the repository for a UI language code ("zh-TW", "en", …).
/// Chinese UI languages get the Traditional Chinese manual, every other one English.
/// Every UI language has its own manual; unknown codes get the English one.
pub fn manual_url(language: &str) -> String {
let file = if language.starts_with("zh") { "zh-TW" } else { "en" };
let file = if crate::locale::is_supported(language) {
language
} else {
"en"
};
format!("{REPO_URL}/blob/main/docs/manual/QRcode-tool-User-Manual-{file}.pdf")
}

Expand All @@ -58,9 +62,11 @@ pub mod app_info {
manual_url("zh-TW"),
"https://github.com/naritaroad/qrcode-tool/blob/main/docs/manual/QRcode-tool-User-Manual-zh-TW.pdf"
);
assert!(manual_url("zh-CN").ends_with("-zh-TW.pdf"));
assert!(manual_url("zh-CN").ends_with("-zh-CN.pdf"));
assert!(manual_url("en").ends_with("-en.pdf"));
assert!(manual_url("ja").ends_with("-en.pdf"));
assert!(manual_url("ja").ends_with("-ja.pdf"));
assert!(manual_url("pt-BR").ends_with("-pt-BR.pdf"));
assert!(manual_url("xx").ends_with("-en.pdf"));
assert!(crate::url_safety::analyze_url(&manual_url("de")).is_ok());
}
}
Expand Down
12 changes: 11 additions & 1 deletion docs/TRANSLATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,17 @@ Language*. The language switches immediately.
(`Language`, `Plural-Forms`) and translate.
3. Add the language to `LANGUAGES` in `crates/qrtool-core/src/locale.rs` (code and native name)
and to `locale::resolve` if the system locale needs mapping.
4. Add the language to the table above and to the README.
4. Add the language to the table above and to the language links at the top of every README.
5. Optionally add `docs/i18n/README.<code>.md` and a user manual (see below).

## README and user manual

Each language has a README in `docs/i18n/README.<code>.md` and a user manual built from
`docs/manual/build/content.<code>.js` (text) and `docs/manual/build/docscenes/strings.<code>.json`
(texts of the mock desktop in the screenshots). Keep the README sections and the manual blocks in
the same order as the English ones. Rebuild one manual with
`docs\manual\build\build.ps1 -Langs <code>` (see `docs/manual/README.md`). Only the English and
Traditional Chinese manuals are attached to releases; the others are linked from `docs/manual`.

## For developers: changing UI text

Expand Down
Loading
Loading