Docs: add a Windows troubleshooting section to the README #33

Activity

1. codepiyusss

   added

   documentationDocs and README workDocs and README work

   good first issueGood for newcomersGood for newcomers

   easyEasy difficultyEasy difficulty

   on Oct 8, 2026
2. Giorgx12 commented on Oct 9, 2026

   

   Giorgx12

   on Oct 9, 2026

   More actions

   In your opinion, could I do this? It's only the readme and troubleshooting, isn't it?
3. codepiyusss commented on Oct 10, 2026

   

   codepiyusss

   on Oct 10, 2026

   OwnerAuthor

   More actions

   Hi!
   Yes, you can take this one, I’ll assign it to you. It is a documentation-only change: edit README.md only, no code and no tests.

   What to do: add a new section called ## Windows troubleshooting to the README, after the quickstart. It should cover:

   1. Activating the virtual environment

      • PowerShell: venv\Scripts\Activate.ps1
      • cmd: venv\Scripts\activate.bat
      • Note that the source venv/bin/activate command in the quickstart is for Mac/Linux only.

   2. PowerShell blocks the activation script (an error about “running scripts is disabled”). The fix is Set-ExecutionPolicy -Scope CurrentUser RemoteSigned.

   3. fixit is not recognized. Explain the likely causes and fixes:

      • The virtual environment is not activated.
      • pip install -e ".[dev]" was not run yet.
      • Workaround that always works: python -m fixit wc "hello world".

   4. python is not recognized. Try py instead, for example py -m venv venv.

   Please test it yourself: run each command on your Windows machine and only document what actually works for you. Don’t copy fixes from the internet that you haven’t tried.

   Rules for this PR:

   • Change only README.md, and only add the new section. Don’t reformat or rewrite other parts.
   • No emojis (our markdown files don’t use them).
   • Use code blocks for every command.
   • Keep it short, around 25 lines.
   • Fill in the PR template and write Closes #33.

   Open the PR when you’re ready and I’ll review it. Ask here if anything is unclear.
4. Giorgx12 commented on Oct 13, 2026

   

   Giorgx12

   on Oct 13, 2026

   More actions

   Can I separate Windows from Linux activation? Pls see my fork
5. codepiyusss commented on Oct 13, 2026

   

   codepiyusss

   on Oct 13, 2026

   OwnerAuthor

   More actions

   Open the PR i'll review there.
   Thanks!