docs: update installation instructions for Windows to include Installer and Winget options#1213
Merged
Conversation
…er and Winget options
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the user-facing installation documentation to clearly present two Windows install paths (installer vs. Winget), aligning English and Japanese docs.
Changes:
- Add Windows installation subsections for “Using the Installer” and “Using Winget” (with
winget install ...) inREADME.md. - Mirror the same Windows installation structure and Winget instructions in
docs/README.ja.md. - Clean up the Roadmap table formatting in
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/README.ja.md | Adds installer/Winget subsections under Windows installation and updates the TOC accordingly. |
| README.md | Adds installer/Winget subsections under Windows installation, updates the TOC, and fixes Roadmap table formatting. |
Comments suppressed due to low confidence (2)
docs/README.ja.md:72
- 見出しでは「インストーラ」、本文では「インストーラー」と表記ゆれがあります。どちらかに統一するとドキュメント内での検索性と一貫性が上がります。
#### インストーラを使用する
1. ダウンロードページから `HardwareVisualizer_x.x.x_x64-setup_windows.exe` または `HardwareVisualizer_x.x.x_x64_en-US_windows.msi` をダウンロードします。
2. インストーラー（`.exe` または `.msi` ファイル）を実行します。
docs/README.ja.md:79
- 行末に全角スペースが入っているようです（Markdown の改行目的なら半角スペース2つが必要）。意図がなければ削除し、意図があるなら Markdown として有効な空白に置き換えてください。
Windows の場合、Windows Package Manager（Winget）を使用してインストールすることもできます。
PowerShell またはコマンドプロンプトで以下のコマンドを実行してください。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the installation instructions in both the English and Japanese
READMEfiles to clarify Windows installation options and improve the formatting of the roadmap table. The main changes are the addition of detailed instructions for installing via the Windows installer and Winget, as well as minor formatting fixes.Documentation improvements:
README.md, providing clear step-by-step instructions and the exact Winget command for installation. [1] [2]docs/README.ja.md) to include equivalent subsections and instructions for both installer-based and Winget-based Windows installation. [1] [2]Formatting updates:
README.mdfor better readability.