diff --git a/BUILD.md b/BUILD.md index 104b3d7..602c2c3 100644 --- a/BUILD.md +++ b/BUILD.md @@ -34,22 +34,28 @@ This repository has been built and tested on Debian 12.5 (Bookworm) on an AMD64 #### Required Package List -`apt install curl maven clang cmake libssl-dev zlib1g-dev liblzma-dev libbz2-dev gcc-aarch64-linux-gnu gcc-mingw-w64-x86-64-win32` +```bash +apt install curl maven clang cmake libssl-dev zlib1g-dev liblzma-dev libbz2-dev gcc-aarch64-linux-gnu gcc-mingw-w64-x86-64-win32 +``` #### Install and Prepare Required Rust Version This repository has been built and tested with Rust version 1.78. To install the newest version, run the following command: -`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` +```bash +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` If a newer version doesn't work, a specific version can be installed with the following command: -`$ curl --proto '=https' --tls1.2 -sSf https://sh.rustup.rs/ | sh -s --default-toolchain=1.78.0` +```bash +$ curl --proto '=https' --tls1.2 -sSf https://sh.rustup.rs/ | sh -s --default-toolchain=1.78.0 +``` For more information see this [GitHub Issue](https://github.com/rust-lang/rustup/issues/2882). After installing, run the following commands to get the necessary targets: -``` +```bash rustup target add x86_64-apple-darwin rustup target add aarch64-unknown-linux-gnu rustup target add x86_64-pc-windows-gnu @@ -66,39 +72,43 @@ The macOS SDK is integrated into Xcode, and this repository has been built and t To build and use the macOS SDK from Xcode, [osxcross](https://github.com/tpoechtrager/osxcross) will be used. Download osxcross: -`git clone https://github.com/tpoechtrager/osxcross.git` +```bash +git clone https://github.com/tpoechtrager/osxcross.git +``` Extract macOS SDK from Xcode (see [here](https://github.com/tpoechtrager/osxcross?tab=readme-ov-file#packing-the-sdk-on-linux---method-1-xcode--80)): -`/osxcross/tools/gen_sdk_package_pbzx.sh /Xcode_8.3.3.xip` +```bash +/osxcross/tools/gen_sdk_package_pbzx.sh /Xcode_8.3.3.xip +``` Hint: This method may require up to 45 GB of free disk space. An SSD is recommended for this method. Copy or move the SDK into the `/osxcross/tarballs/` directory. Run: -``` +```bash UNATTENDED=yes OSX_VERSION_MIN=10.12 ./build.sh ``` to create the macOS cross toolchain. Add the target/bin folder to your PATH environment variable: -``` +```bash PATH="/osxcross/target/bin:$PATH" ``` #### Build the Project Clone the project and within the project directory, run: -``` +```bash make ``` to start the build. The compiled warp-packer files are in the folder: -``` +```bash /warp/target//release/warp-packer ``` e.g. -``` +```bash warp/target/aarch64-unknown-linux-gnu/release/warp-packer ``` \ No newline at end of file