Skip to content

README.md: remove misleading "Prerequisites" and "Build Instructions" #3229

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
mmaka1 merged 1 commit into from
Jul 31, 2020
Merged

README.md: remove misleading "Prerequisites" and "Build Instructions" #3229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
89 changes: 0 additions & 89 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<jobs>` for parallel build
```

## Running the tests

See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html)
Expand Down