From 7a4ce754cc4a09e06872ed1f0f9914e462c4c5cf Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 4 Mar 2024 10:59:04 +0100 Subject: [PATCH] Explain who wants this Signed-off-by: Gilles Peskine --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eab84b611..00d5a750c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# mbedtls-framework -TF-PSA-Crypto and Mbed TLS version-independent build and test framework +# Mbed TLS framework + +This repository contains a version-independent build and test framework for [TF-PSA-Crypto](https://github.com/Mbed-TLS/TF-PSA-Crypto) and [Mbed TLS](https://github.com/Mbed-TLS/mbedtls-framework). + +You need this repository as a Git submodule in a branch of one of the above repositories if: + +* You want to build, test or contribute to Mbed TLS 3.6.0 or above, and you are working from a snapshot of a Git commit on a development branch. +* You want to build, test or contribute to TF-PSA-Crypto, and you are working from a snapshot of a Git commit on a development branch. + +You do not need this repository if: + +* You are working with Mbed TLS 2.28. +* You want to build or test a release of Mbed TLS.