From 429e90153cc7ad57d22aaa3cc00d2d73f760f4dd Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Tue, 7 Mar 2023 20:40:04 +0100 Subject: [PATCH] Improve pip instructions Our build scripts invoke `python3` in preference to `python`, so make the default instruction use `python3`. On many systems (macOS, some Linux), `python` invokes Python 2 which our scripts do not support. Suggest --user by default. It's usually the right thing outside of venvs. Signed-off-by: Gilles Peskine --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4bf4e1420..288e692baf 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,11 @@ The source code of Mbed TLS includes some files that are automatically generated The following tools are required: * Perl, for some library source files and for Visual Studio build files. -* Python 3 and some Python packages, for some library source files, sample programs and test data. To install the necessary packages, run +* Python 3 and some Python packages, for some library source files, sample programs and test data. To install the necessary packages, run: ``` - python -m pip install -r scripts/basic.requirements.txt + python3 -m pip install --user -r scripts/basic.requirements.txt ``` + Depending on your Python installation, you may need to invoke `python` instead of `python3`. To install the packages system-wide, omit the `--user` option. * A C compiler for the host platform, for some test data. If you are cross-compiling, you must set the `CC` environment variable to a C compiler for the host platform when generating the configuration-independent files.