Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct the installation instructions for Windows #1485

Merged
merged 1 commit into from
Feb 22, 2025
Merged
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
23 changes: 23 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,10 @@ Installing on Windows
Native Windows
--------------

..
If you have a Windows that is not the Home edition, you can use Windows Sandbox to test on a blank Windows instance.
https://learn.microsoft.com/en-us/windows/security/application-security/application-isolation/windows-sandbox/

.. note::

Administrator privileges will be required for some of these steps.
Expand Down Expand Up @@ -430,6 +434,25 @@ Administrator.):

* ``python3 -m pip install ocrmypdf``

..
The Windows Python versions do not place any python or python3 executable in the path.
They add the py launcher to the path:
https://docs.python.org/3/using/windows.html#python-launcher-for-windows

If you installed Python using WinGet, then use the following command instead:

* ``py -m pip install ocrmypdf``

and use:

* ``py -m ocrmypdf``

To start OCRmyPDF.

If you intend to use more Python software on your Windows machine, consider the use of
`pipx <https://pipx.pypa.io/stable/>`_ or a similar tool to create isolated Python
environments for each Python software that you want to use.

OCRmyPDF will check the Windows Registry and standard locations in your Program Files
for third party software it needs (specifically, Tesseract and Ghostscript). To
override the versions OCRmyPDF selects, you can modify the ``PATH`` environment
Expand Down
Loading