From a8e50f6faa452f22daaa4905ae84c4a4d0e83297 Mon Sep 17 00:00:00 2001
From: Philipp Wagner <mail@philipp-wagner.com>
Date: Wed, 7 Aug 2019 11:38:19 +0100
Subject: [PATCH] Add README

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9716f94
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+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.
+
+Head over to the GitHub releases for this repository for pre-built toolchains.
+
+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
+
+  ```bash
+  VERSION=$(date +%Y%m%d)-1
+  git tag -a -m "Release version $VERSION" $VERSION
+  ```
+
+3. Push the tag
+
+  ```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).