doc: add installation instructions for Windows 11 (WSL/Debian)#7
Merged
github-actions[bot] merged 1 commit intokdudka:mainfrom Mar 16, 2026
Merged
doc: add installation instructions for Windows 11 (WSL/Debian)#7github-actions[bot] merged 1 commit intokdudka:mainfrom
github-actions[bot] merged 1 commit intokdudka:mainfrom
Conversation
Reviewer's GuideAdds a new Windows 11 + WSL2 (Debian) specific installation guide documenting how to set up the environment, install dependencies, and build/use the project, modeled after existing distro-specific READMEs. Flow diagram for Windows 11 WSL Debian pdx setup stepsflowchart TD
A[Start on Windows 11] --> B[Open PowerShell as Administrator]
B --> C[Run wsl --install -d Debian]
C --> D[Create Debian UNIX username and password]
D --> E[Launch Debian via Start Menu or wsl -d Debian]
E --> F[Run sudo apt update && sudo apt upgrade -y]
F --> G[Install dependencies with sudo apt install python-is-python3 python3-venv git podman]
G --> H[Check python3 --version]
H --> I{Python >= 3.13}
I -- Yes --> J[Clone repository with git clone https://github.com/kdudka/pdx]
I -- No --> K[Install newer Python via pyenv or Debian backports]
K --> H
J --> L[cd pdx and follow main build documentation]
L --> M[Optionally navigate to Windows workspace at /mnt/c/Users/YourWindowsUser]
M --> N[Optionally install qimgv with sudo apt install qimgv]
N --> O[Use pdx and view photos with qimgv]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- Consider annotating the code fences with languages (e.g.,
powershell,bash) so that commands for Windows vs WSL/Debian are clearly distinguished and get proper syntax highlighting. - The Python 3.13+ requirement may not match what Debian currently provides; it could be helpful to either mention a specific Debian release that satisfies this or give a concrete pyenv/backports example so users aren’t blocked at this step.
- The note
-- Note:under the Python section looks like a list item typo; rephrase it as a proper bullet point or a separate paragraph to avoid confusion in the rendered Markdown.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider annotating the code fences with languages (e.g., ```powershell```, ```bash```) so that commands for Windows vs WSL/Debian are clearly distinguished and get proper syntax highlighting.
- The Python 3.13+ requirement may not match what Debian currently provides; it could be helpful to either mention a specific Debian release that satisfies this or give a concrete pyenv/backports example so users aren’t blocked at this step.
- The note `-- Note:` under the Python section looks like a list item typo; rephrase it as a proper bullet point or a separate paragraph to avoid confusion in the rendered Markdown.
## Individual Comments
### Comment 1
<location path="README-Windows.md" line_range="1" />
<code_context>
+# Installation steps specific for Windows 11 with Debian distribution
+
+This guide provides instructions for setting up and building `pdx` on a Windows 11 machine using the Windows Subsystem for Linux (WSL) with a Debian distribution.
</code_context>
<issue_to_address>
**suggestion (typo):** Consider changing "specific for" to "specific to" for more natural wording.
For example: "Installation steps specific to Windows 11 with Debian distribution" reads more naturally.
```suggestion
# Installation steps specific to Windows 11 with Debian distribution
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Collaborator
Author
|
Hi @kdudka , I've added a README-Windows.md file to help users set up pdx on Windows 11/WSL/Debian, following the structure of the existing Gentoo documentation. Please let me know if you'd like any changes! |
This commit adds README-Windows.md to support users running pdx on Windows 11 via WSL2 (Debian). Key additions: Step-by-step instructions for enabling WSL and setting up the Debian environment. Required dependency list (including podman and qimgv for image viewing). I have patterned this after the existing README-Gentoo.md to maintain consistency within the repository.
kdudka
approved these changes
Mar 16, 2026
Collaborator
Author
|
/fast-forward |
|
Successfully fast-forwarded! 🚀 |
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 commit adds README-Windows.md to support users running pdx on Windows 11 via WSL2 (Debian).
Key additions:
Step-by-step instructions for enabling WSL and setting up the Debian environment.
Required dependency list (including podman and qimgv for image viewing).
I have patterned this after the existing README-Gentoo.md to maintain consistency within the repository.
Summary by Sourcery
Documentation: