Skip to content

Commit 12a81f2

Browse files
committed
docs/install: pip>=23.0 is required.
Fixes #745.
1 parent ca77de5 commit 12a81f2

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/install.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ System requirements
66

77
.. |yosys-version| replace:: 0.10 (or newer)
88

9-
Amaranth HDL requires Python 3.7; it works on CPython_ 3.7 (or newer), and works faster on PyPy3.7_ 7.3.3 (or newer).
9+
Amaranth HDL requires Python 3.7; it works on CPython_ 3.7 (or newer), and works faster on PyPy3.7_ 7.3.3 (or newer). Installation requires pip_ 23.0 (or newer).
1010

1111
For most workflows, Amaranth requires Yosys_ |yosys-version|. A compatible version of Yosys is distributed via PyPI_ for most popular platforms.
1212

@@ -18,6 +18,7 @@ Synthesizing, placing and routing an Amaranth design for an FPGA requires the FP
1818
1919
.. _CPython: https://www.python.org/
2020
.. _PyPy3.7: https://www.pypy.org/
21+
.. _pip: https://pip.pypa.io/
2122
.. _Yosys: https://yosyshq.net/yosys/
2223
.. _PyPI: https://pypi.org/
2324
.. _GTKWave: http://gtkwave.sourceforge.net/
@@ -29,6 +30,7 @@ Installing prerequisites
2930
========================
3031

3132
.. |builtin-yosys-architectures| replace:: x86_64 and AArch64
33+
.. |upgrade-pip| replace:: Before continuing, make sure you have the latest version of pip_ installed by running:
3234

3335
.. platform-picker::
3436

@@ -41,6 +43,12 @@ Installing prerequisites
4143

4244
.. _Download GTKWave: https://sourceforge.net/projects/gtkwave/files/
4345

46+
|upgrade-pip|
47+
48+
.. code-block:: doscon
49+
50+
> pip install --upgrade pip
51+
4452
.. platform-choice:: macos
4553
:title: macOS
4654

@@ -52,6 +60,12 @@ Installing prerequisites
5260
5361
.. _Homebrew: https://brew.sh
5462

63+
|upgrade-pip|
64+
65+
.. code-block:: console
66+
67+
$ pip install --upgrade pip
68+
5569
.. platform-choice:: debian
5670
:altname: linux
5771
:title: Debian
@@ -70,6 +84,12 @@ Installing prerequisites
7084
7185
If Yosys |yosys-version| is not available, `build Yosys from source`_.
7286

87+
|upgrade-pip|
88+
89+
.. code-block:: console
90+
91+
$ pip3 install --user --upgrade pip
92+
7393
.. platform-choice:: arch
7494
:altname: linux
7595
:title: Arch Linux
@@ -91,6 +111,11 @@ Installing prerequisites
91111

92112
.. _build Yosys from source: https://github.com/YosysHQ/yosys/#setup
93113

114+
|upgrade-pip|
115+
116+
.. code-block:: console
117+
118+
$ pip3 install --user --upgrade pip
94119
95120
.. _install:
96121

0 commit comments

Comments
 (0)