Skip to content

Commit

Permalink
Merge pull request #757 from jdemel/readme-cpu-features
Browse files Browse the repository at this point in the history
cpu_features: Update hints in README
  • Loading branch information
jdemel authored Mar 2, 2024
2 parents ab2ab82 + 4464716 commit 7dd2d0a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down

0 comments on commit 7dd2d0a

Please sign in to comment.