Skip to content

Commit c2a0456

Browse files
committed
Update README
1 parent 9eb8013 commit c2a0456

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
11
lowRISC toolchain builds
22
========================
33

4-
This repository contains tools to create toolchains for lowRISC internal use.
5-
The toolchains are *not supported* by lowRISC or recommended to be used outside of lowRISC.
4+
This repository contains tools to create toolchains for lowRISC internal
5+
use. The toolchains are *not supported* by lowRISC or recommended to be
6+
used outside of lowRISC.
67

7-
Head over to the GitHub releases for this repository for pre-built toolchains.
8+
Head over to the
9+
[GitHub releases for this repository](https://github.com/lowRISC/lowrisc-toolchains/releases)
10+
for pre-built toolchains.
11+
12+
* A GCC RV32IMC without hardfloat support, targeting [Ibex](https://github.com/lowRISC/ibex/)
13+
* A GCC multilib toolchain
814

915
How to do a release
1016
-------------------
1117

1218
1. Modify `RISCV_GNU_TOOLCHAIN_COMMIT_ID` in `azure-pipelines.yml` and
1319
other build scripts and flags as needed.
1420

15-
2. Tag a release
21+
2. Push the changes or do a pull request, and wait for the pipeline to
22+
complete.
23+
24+
The build can be tested by downloading the Azure Pipeline artifacts.
25+
1. Go to the [lowrisc-toolchains Azure Pipelines page](https://dev.azure.com/lowrisc/lowrisc-toolchains/_build?definitionId=2&_a=summary)
26+
2. Select a build
27+
3. Click on "Artifacts" (top right)
28+
4. Download the desired artifact, and test it.
29+
30+
3. Tag a release
1631

17-
```bash
18-
VERSION=$(date +%Y%m%d)-1
19-
git tag -a -m "Release version $VERSION" $VERSION
20-
```
32+
```bash
33+
VERSION=$(date +%Y%m%d)-1
34+
git tag -a -m "Release version $VERSION" $VERSION
35+
```
2136

22-
3. Push the tag
37+
4. Push the tag
2338

24-
```bash
25-
git push origin $VERSION
26-
```
39+
```bash
40+
git push origin $VERSION
41+
```
2742

28-
Now the release builds on Azure Pipelines, and the resulting binaries
29-
will be uploaded to
30-
[GitHub releases](https://github.com/lowRISC/lowrisc-toolchains/releases).
43+
Now the release builds on Azure Pipelines, and the resulting binaries
44+
will be uploaded to
45+
[GitHub releases](https://github.com/lowRISC/lowrisc-toolchains/releases).

0 commit comments

Comments
 (0)