Skip to content

README.md: clarify platform applicability #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 2 commits into from
Jan 23, 2025
Merged

README.md: clarify platform applicability #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee0d0f2
README.md: clarify platform applicability
kv2019i Jan 21, 2025
151c7be
tests: modify tarball_multi 2023.09 test
kv2019i Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## Notice on Platform Coverage

While sof-bin repository is open to all vendors, in practise only
binaries for Intel based systems have been distributed using this
method so far. For pragmatic reasons, examples in this documentation
use Intel binaries as examples as those are currently available.

WARNING: starting with v2.2, older Intel products are not supported by
the main SOF development branch anymore. To avoid duplication and
confusion in this sof-bin git repository, older product generations are
Expand Down Expand Up @@ -37,6 +42,9 @@ sudo mv /usr/local/bin/sof-* some_backup_location/ # optional
sudo ./install.sh
```

The install script is intended for Linux systems where the Linux kernel
will look up firmware binaries under /lib/firmware.

## Install process with install.sh (sof-bin git tree)

To run install from sof-bin git checkout:
Expand Down
4 changes: 4 additions & 0 deletions tests/tests.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ test_install_one_version()
# anymore
git show v2023.12.1:install.sh > "$(pwd)/sof-bin-$ver"/install.sh

# install.sh was updated in 2025.01, so it won't match
# anymore
git show v2023.12.1:README.md > "$(pwd)/sof-bin-$ver"/README.md

diff -qr "$EXTR_REFS"/sof-bin-"$ver" "$(pwd)/sof-bin-$ver"/

popd || exit 1
Expand Down
Loading