Repository navigation
README.md: remove misleading "Prerequisites" and "Build Instructions" - #3229
Conversation
The "Prerequisites" and "Build Instructions" sections are dangerously incomplete: they don't say a word about toolchains. Someone on gitter just wondered why they don't work. sof-docs is the reference now and lucky us that's already the first thing at the top of the file so keep that. Remove these two sections so their build commands stop tempting readers to skip the link to the unfortunately longer but necessary sof-docs instructions. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
|
The rendered, new READE.md can be seen at Files Changed tab -> ... menu -> View File We've also been working on a toolchain FAQ BTW, hopefully something this week. |
paulstelian97
left a comment
paulstelian97
left a comment
There was a problem hiding this comment.
Are these commands put somewhere else in the guide so we aren't forced to depend on the xtensa-build-all scripts? The commands are useful in the proper context.
I think they are, please check: https://thesofproject.github.io/latest/getting_started/build-guide/build-from-scratch.html#incremental-builds See similar concerns discussed in PR #3064 |
|
I'm pretty sure the CI failure is highly related to this change, we should definitely pay close attention to it 😉 |
The "Prerequisites" and "Build Instructions" sections are dangerously
incomplete: they don't say a word about toolchains. Someone on gitter
just wondered why they don't work. sof-docs is the reference now and
lucky us that's already the first thing at the top of the file so keep
that. Remove these two sections so their build commands stop tempting
readers to skip the link to the unfortunately longer but necessary
sof-docs instructions.
Signed-off-by: Marc Herbert marc.herbert@intel.com