From 44647162972ab33c25742b3e2e40dddd0fa992c2 Mon Sep 17 00:00:00 2001 From: Johannes Demel Date: Sat, 24 Feb 2024 14:12:46 +0100 Subject: [PATCH] cpu_features: Update hints in README We should prefer a cpu_features version that is provided thru package managers. The README clearly states this preference now. Signed-off-by: Johannes Demel --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16643761f..9f1f0d040 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,15 @@ $ volk_profile ``` #### Missing submodule -We use [cpu_features](https://github.com/google/cpu_features) as a git submodule to detect CPU features, e.g. AVX. -There are two options to get the required code: +We use [cpu_features](https://github.com/google/cpu_features) to detect CPU features, e.g. AVX. +Some platforms require a very recent version that is not available through the appropriate package manager. +In this case you must use `cpu_features` as a submodule. + +**NOTE**: Most package managers provide recent enough `cpu_features` versions by now. +Please default to the provided `cpu_features` version first, and only use the submodule in cases where this fails. +Please open an issue if this is the case. + +There are two options to get the required code in a submodule: ```bash git clone --recursive https://github.com/gnuradio/volk.git ```