diff options
| -rw-r--r-- | BuildInstructions.md | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/BuildInstructions.md b/BuildInstructions.md index 2720ba3478..7552861fcc 100644 --- a/BuildInstructions.md +++ b/BuildInstructions.md @@ -47,6 +47,15 @@ on your platform please submit an issue or a pull request. - `protobuf-devel` on Fedora. - `libprotobuf-dev` on Debian/Ubuntu. +- **`bash` must be installed and available in PATH on all platforms**. This is required for building + the desktop app: +- Bash version 4.0 or later is required for all platforms and must be added to your PATH environment variable. + - Linux: Bash is typically installed by default, otherwise refer to your distribution for instructions on how to install it. + - macOS: The default installed version (3.2.5) is not supported. Install a newer version via Homebrew: `brew install bash` + - Windows: Install [Git for Windows] which includes Git Bash and other required unix utilities. + +[Git for Windows]: https://git-scm.com/download/win + ## Linux ### Debian/Ubuntu @@ -119,8 +128,8 @@ The host has to have the following installed: - Windows 10 (or Windows 11) SDK. -- `bash` installed as well as a few base unix utilities, including `sed` and `tail`. - You are recommended to use [Git for Windows]. +- `bash` and base Unix utilities must be installed and available in PATH (see the requirement in + the [All platforms](#all-platforms) section above). - `zig` installed and available in `%PATH%`. 0.14 or later is recommended: https://ziglang.org/download/. @@ -142,8 +151,6 @@ The host has to have the following installed: rustup target add i686-pc-windows-msvc ``` -[Git for Windows]: https://git-scm.com/download/win - ### Cross-compiling for ARM64 By default, the app will build for the host platform. It is also possible to cross-compile the app |