Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
imphil committed Oct 10, 2019
1 parent 9eb8013 commit c2a0456
Showing 1 changed file with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,45 @@
lowRISC toolchain builds
========================

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

Head over to the GitHub releases for this repository for pre-built toolchains.
Head over to the
[GitHub releases for this repository](https://github.com/lowRISC/lowrisc-toolchains/releases)
for pre-built toolchains.

* A GCC RV32IMC without hardfloat support, targeting [Ibex](https://github.com/lowRISC/ibex/)
* A GCC multilib toolchain

How to do a release
-------------------

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

2. Tag a release
2. Push the changes or do a pull request, and wait for the pipeline to
complete.

The build can be tested by downloading the Azure Pipeline artifacts.
1. Go to the [lowrisc-toolchains Azure Pipelines page](https://dev.azure.com/lowrisc/lowrisc-toolchains/_build?definitionId=2&_a=summary)
2. Select a build
3. Click on "Artifacts" (top right)
4. Download the desired artifact, and test it.

3. Tag a release

```bash
VERSION=$(date +%Y%m%d)-1
git tag -a -m "Release version $VERSION" $VERSION
```
```bash
VERSION=$(date +%Y%m%d)-1
git tag -a -m "Release version $VERSION" $VERSION
```

3. Push the tag
4. Push the tag

```bash
git push origin $VERSION
```
```bash
git push origin $VERSION
```

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

0 comments on commit c2a0456

Please sign in to comment.