aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGilles Peskine <Gilles.Peskine@arm.com>2021-11-17 19:17:03 +0100
committerGilles Peskine <Gilles.Peskine@arm.com>2021-11-17 19:27:45 +0100
commit87485a3f2825f6a644e860db748ca2616797d92d (patch)
treee0fac6608ade06a0252c0c3b8a57d7393ad3b7e8 /README.md
parent9c82cd9f439d7f38f1384037518ce51a5202958a (diff)
downloadmbedtls-87485a3f2825f6a644e860db748ca2616797d92d.zip
mbedtls-87485a3f2825f6a644e860db748ca2616797d92d.tar.gz
mbedtls-87485a3f2825f6a644e860db748ca2616797d92d.tar.bz2
Add requirement on Jinja to integrate drivers
Driver implementers need to regenerate wrappers. This will use Jinja2 as discussed in https://github.com/ARMmbed/mbedtls/pull/5067#discussion_r738794607 On the development branch, driver integration is always needed to generate the driver wrapper and thus to build the library, so this requirement applies to everyone, not just driver implementers. In releases, we plan to include a default driver wrapper with support for basic use cases only, meaning that the line `-r driver.requirements.txt` should be removed from `basic.requirements.txt` in releases. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index c8d9450..ea1d7a3 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,10 @@ 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, for some sample programs and test data.
+* 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
+ ```
* 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.