diff --git a/docs/build_instructions.md b/docs/build_instructions.md index 49f0727..0fc4189 100644 --- a/docs/build_instructions.md +++ b/docs/build_instructions.md @@ -2,13 +2,32 @@ ## Prerequisites for building the encoder +### All platforms + - Bazel: `iamf-tools` uses the Bazel build system. See Bazel's [Getting started](https://bazel.build/start) page for installation instructions. - CMake: required to build some dependencies. See CMake's [Download](https://cmake.org/download/) page to install. +- Clang 13+ or GCC 10+ for Linux-like systems or MSVC for Windows. + +### Additional Windows prerequisites + +Windows requires some additional prerequisites: + +- MSYS32: See [msys2.org](https://www.msys2.org/) for installation + instructions. +- MSCV: Follow Bazel's + [Build on Windows](https://bazel.build/configure/windows) for installation + instructions. +- Address + [long path issues](https://bazel.build/configure/windows#long-path-issues) + by adding the following to `iamf-tools/.bazelrc` or another + [custom .bazelrc](https://bazel.build/run/bazelrc) file: -## Building the encoder on Linux + `startup --output_user_root=C:/tmp` + +## Building the encoder Building the encoder binary: @@ -24,9 +43,10 @@ bazel test -c opt //iamf/... ## Test suite -[iamf/cli/testdata](../iamf/cli/testdata) covers a wide variety of IAMF features. -These samples can be used as encoder input. After encoding the resultant `.iamf` -files can be used to assist in testing or debugging an IAMF-compliant decoder. +[iamf/cli/testdata](../iamf/cli/testdata) covers a wide variety of IAMF +features. These samples can be used as encoder input. After encoding the +resultant `.iamf` files can be used to assist in testing or debugging an +IAMF-compliant decoder. See the separate [README.md](../iamf/cli/testdata/README.md) for further documentation. @@ -63,4 +83,6 @@ documentation. * `docs/` - Documentation. ## Contributing -If you have improvements or fixes, we would love to have your contributions. See [CONTRIBUTING.md](../CONTRIBUTING.md) for details. + +If you have improvements or fixes, we would love to have your contributions. See +[CONTRIBUTING.md](../CONTRIBUTING.md) for details.