From 18589ae5aeed2a9d99a4bb256b28c2b8d4b9d34c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Thei=C3=9Fen?= Date: Thu, 2 May 2024 11:57:21 +0200 Subject: [PATCH] Update README.md (#28) Fixes #26 Fixes #27 --- .github/workflows/build_and_release.yml | 2 ++ README.md | 28 ++++++++++++++++++++++--- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build_and_release.yml b/.github/workflows/build_and_release.yml index 180e32e..615c862 100644 --- a/.github/workflows/build_and_release.yml +++ b/.github/workflows/build_and_release.yml @@ -4,6 +4,8 @@ on: push: branches: - main + paths-ignore: + - README.md permissions: contents: write diff --git a/README.md b/README.md index a3606bf..81c7fbe 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,41 @@ This repository compile and publish as release final binaries of the Rust toolchain targetting RISC-V RV32E. -## Download +## Building + +```sh +./clone.sh +./patch.sh +./build.sh +./package.sh +``` + +Executing those steps will create a `rust-rve-nightly-$rust_commit_date-$TOOLCHAIN_HOST_TRIPLET.xz` in your working directory. See the next chapter about installation how to use this +toolchain with rustup. + +## Installation + +You can either download a package from the release page or build it yourself with the instructions above. The following steps will make the toolchain available via rustup's +`+rve-nightly` syntax. ``` sh -# Download the latest release from the release page. -tar --zstd -xf rust-rve-nightly-2023-04-05-aarch64-apple-darwin.tar.zst +tar --zstd -xf rust-rve-nightly-$rust_commit_date-$TOOLCHAIN_HOST_TRIPLET.xz mv rve-nightly ~/.rustup/toolchains/ +# Clear the "downloaded" attribute recursively on macOS to satisfy GateKeeper +xattr -rc ~/.rustup/toolchains/rve-nightly ``` +The last step is needed when downloading the binary toolchain with Safari. Otherwise GateKeeper will prevent running downloaded binaries without code signature: + +326768663-26a8b06f-5074-485e-9677-12806b0454bd + ## Build with `ci-unified` If there is a need to build the toolchain using [Parity default CI environment](https://github.com/paritytech/scripts/tree/master/dockerfiles/ci-unified), tweak the build step as follows: ``` export CXX=/usr/bin/clang++-15 +... ./build.sh --DCMAKE_BUILD_TYPE=Release +... ```