diff --git a/CONTRIBUTING.md b/README.md similarity index 71% rename from CONTRIBUTING.md rename to README.md index 8f84124..ff3f7f3 100644 --- a/CONTRIBUTING.md +++ b/README.md @@ -1,3 +1,9 @@ +# Rust Multi-OS Template + +A template project for building Rust applications targeting multiple operating systems and architectures using `cargo-zigbuild`. + +I've confirmed that the outputs of these builds work on the respective platforms outlined below. + # Setup ```shell @@ -13,30 +19,26 @@ cargo install --locked cargo-zigbuild ```shell # Linux x86_64 rustup target add x86_64-unknown-linux-gnu # ONCE -just build-linux-arm +just build-linux-64 ## OR # Linux ARM64 rustup target add aarch64-unknown-linux-gnu # ONCE -just build-linux-64 - -## OR -# Windows ARM64 -rustup target add aarch64-pc-windows-gnullvm # ONCE -just build-windows-arm +just build-linux-arm ## OR # Windows x86_64 rustup target add x86_64-pc-windows-gnu # ONCE just build-windows-64 +## OR +# Windows ARM64 +rustup target add aarch64-pc-windows-gnullvm # ONCE +just build-windows-arm + ## OR # macOS Universal rustup target add x86_64-apple-darwin rustup target add aarch64-apple-darwin just build-macos ``` - -# Windows support note: - -https://github.com/rust-cross/cargo-zigbuild/issues/328 \ No newline at end of file