Add README.txt for TF-PSA-Crypto configs

This commit adds a README.txt for TF-PSA-Crypto configs. The README specifies how configuration files can be loaded for TF-PSA-Crypto via CMake. Signed-off-by: Harry Ramsey <[email protected]>
Mbed-TLS · Jan 13, 2025 · e299112 · e299112
1 parent 52627fe
commit e299112
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/configs/README.txt b/configs/README.txt
@@ -0,0 +1,17 @@
+This directory contains example configuration files.
+
+The examples are generally focused on a particular usage case (eg, support for
+a restricted number of ciphersuites) and aim at minimizing resource usage for
+this target. They can be used as a basis for custom configurations.
+
+These files are complete replacements for the default crypto_config.h. To use one of
+them, you can pick one of the following methods:
+
+1. Replace the default file include/psa/crypto_config.h with the chosen one.
+
+2. Define TF_PSA_CRYPTO_CONFIG_FILE and adjust the include path accordingly.
+    For example, using cmake:
+
+    find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
+    CFLAGS="-I$PWD/configs -DMTF_PSA_CRYPTO_CONFIG_FILE='<foo.h>'" cmake .
+    make