From 53e1fccf010b20426607cdd2376de607836cada8 Mon Sep 17 00:00:00 2001 From: Marc Herbert Date: Thu, 23 Jul 2020 15:02:47 -0700 Subject: [PATCH] README.md: remove misleading "Prerequisites" and "Build Instructions" 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 --- README.md | 89 ------------------------------------------------------- 1 file changed, 89 deletions(-) diff --git a/README.md b/README.md index 06941093cce1..916c7d6a5a5c 100644 --- a/README.md +++ b/README.md @@ -9,95 +9,6 @@ See [docs](https://thesofproject.github.io/latest/index.html) -### Prerequisites - -* Docker -* CMake (version >= 3.10) - -### Build Instructions - -1. Create directory in checked out repo for build files: -``` -mkdir build && cd build -``` - -2. Run configuration for your toolchain: - -Baytrail / Cherrytrail: - -``` -cmake -DTOOLCHAIN=xtensa-byt-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-byt-elf .. -``` - -Haswell / Broadwell: - -``` -cmake -DTOOLCHAIN=xtensa-hsw-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-hsw-elf .. -``` - -Apollolake: - -``` -cmake -DTOOLCHAIN=xtensa-apl-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-apl-elf .. -``` - -Cannonlake: - -``` -cmake -DTOOLCHAIN=xtensa-cnl-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-cnl-elf .. -``` - -3. Apply default config for your platform. - -Baytrail: - -``` -make baytrail_defconfig -``` - -Cherrytrail: - -``` -make cherrytrail_defconfig -``` - -Haswell: - -``` -make haswell_defconfig -``` - -Broadwell: - -``` -make broadwell_defconfig -``` - -Apollolake: - -``` -make apollolake_defconfig -``` - -Cannonlake: - -``` -make cannonlake_defconfig -``` - -4. (Optional) Customize your configuration - -``` -make menuconfig -``` - -5. Build firmware - -``` -make bin -# or `make bin -j` for parallel build -``` - ## Running the tests See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html)