Skip to content

Commit 18589ae

Browse files
authored
Update README.md (paritytech#28)
Fixes paritytech#26 Fixes paritytech#27
1 parent d9cd6ea commit 18589ae

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

.github/workflows/build_and_release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ on:
44
push:
55
branches:
66
- main
7+
paths-ignore:
8+
- README.md
79

810
permissions:
911
contents: write

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,41 @@
22

33
This repository compile and publish as release final binaries of the Rust toolchain targetting RISC-V RV32E.
44

5-
## Download
5+
## Building
6+
7+
```sh
8+
./clone.sh
9+
./patch.sh
10+
./build.sh
11+
./package.sh
12+
```
13+
14+
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
15+
toolchain with rustup.
16+
17+
## Installation
18+
19+
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
20+
`+rve-nightly` syntax.
621

722
``` sh
8-
# Download the latest release from the release page.
9-
tar --zstd -xf rust-rve-nightly-2023-04-05-aarch64-apple-darwin.tar.zst
23+
tar --zstd -xf rust-rve-nightly-$rust_commit_date-$TOOLCHAIN_HOST_TRIPLET.xz
1024
mv rve-nightly ~/.rustup/toolchains/
25+
# Clear the "downloaded" attribute recursively on macOS to satisfy GateKeeper
26+
xattr -rc ~/.rustup/toolchains/rve-nightly
1127
```
1228

29+
The last step is needed when downloading the binary toolchain with Safari. Otherwise GateKeeper will prevent running downloaded binaries without code signature:
30+
31+
<img width="245" alt="326768663-26a8b06f-5074-485e-9677-12806b0454bd" src="https://github.com/paritytech/rustc-rv32e-toolchain/assets/2580396/5fd140ae-526c-435c-8e6c-ba91a3ab27d3">
32+
1333
## Build with `ci-unified`
1434

1535
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:
1636

1737
```
1838
export CXX=/usr/bin/clang++-15
39+
...
1940
./build.sh --DCMAKE_BUILD_TYPE=Release
41+
...
2042
```

0 commit comments

Comments
 (0)