Skip to content

doc: add installation instructions for Windows 11 (WSL/Debian)#7

Merged
github-actions[bot] merged 1 commit intokdudka:mainfrom
iswiac:main
Mar 16, 2026
Merged

doc: add installation instructions for Windows 11 (WSL/Debian)#7
github-actions[bot] merged 1 commit intokdudka:mainfrom
iswiac:main

Conversation

@iswiac
Copy link
Copy Markdown
Collaborator

@iswiac iswiac commented Mar 15, 2026

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:

  • Document Windows 11 WSL2 (Debian) installation and setup steps, including dependencies and optional tools for viewing photos.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Mar 15, 2026

Reviewer's Guide

Adds 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 steps

flowchart 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]
Loading

File-Level Changes

Change Details Files
Introduce Windows 11 WSL2 (Debian) installation guide for pdx users.
  • Create README-Windows.md with step-by-step instructions to enable WSL and install the Debian distribution via PowerShell.
  • Document Debian-side environment setup including launching WSL, updating packages, and installing required dependencies such as Python, venv, git, and podman.
  • Add instructions to verify Python version compatibility and reference pyenv/Debian backports if a newer Python is needed.
  • Describe cloning the repository and delegating build details to the main documentation to avoid duplication.
  • Explain interaction with the Windows filesystem via /mnt/c and provide optional package guidance for using qimgv as the image viewer under WSL instead of gwenview.
README-Windows.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@iswiac
Copy link
Copy Markdown
Collaborator Author

iswiac commented Mar 15, 2026

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!

Copy link
Copy Markdown
Owner

@kdudka kdudka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iswiac Looks good. Thanks!

Please apply the suggestion from Sourcery AI and squash the fixup commits.

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.
@iswiac
Copy link
Copy Markdown
Collaborator Author

iswiac commented Mar 16, 2026

/fast-forward

@github-actions
Copy link
Copy Markdown

Successfully fast-forwarded! 🚀

@github-actions github-actions bot merged commit f2c44a2 into kdudka:main Mar 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants