Skip to content

Commit f81d9f4

Browse files
authored
Add some notes about running on Windows (#175)
1 parent 89aba3c commit f81d9f4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

doc/usage.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,27 @@ extension. Commands on Fedora to install dependencies:
2828
* Python 3: ``sudo dnf install python3-devel``
2929
* PyPy: ``sudo dnf install pypy-devel``
3030

31+
Windows notes
32+
-------------
33+
34+
On Windows, to allow pyperformance to build dependencies from source
35+
like ``greenlet``, ``dulwich`` or ``psutil``, if you want to use a
36+
``python.exe`` built from source, you should not use the ``python.exe``
37+
directly. Instead, you must run the little-known command ``PC\layout``
38+
to create a filesystem layout that resembles an installed Python::
39+
40+
.\python.bat -m PC.layout --preset-default --copy installed -v
41+
42+
(Use the ``--help`` flag for more info about ``PC\layout``.)
43+
44+
Now you can use the "installed" Python executable::
45+
46+
installed\python.exe -m pip install pyperformance
47+
installed\python.exe -m pyperformance run ...
48+
49+
Using an *actually* installed Python executable (e.g. via ``py``)
50+
works fine too.
51+
3152

3253
Run benchmarks
3354
==============

0 commit comments

Comments
 (0)