From 5889deea7b92aec900bdaea3b0480c5826023702 Mon Sep 17 00:00:00 2001
From: Dmitry Kurtaev <dmitry.kurtaev@gmail.com>
Date: Thu, 18 Jan 2024 13:56:37 +0300
Subject: [PATCH] Add README.md

---
 .github/workflows/build.yaml |  8 +-------
 README.md                    | 35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 35 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 83cb02f..1394552 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -3,7 +3,7 @@ name: Build RISC-V runner
 on: [workflow_dispatch, pull_request]
 
 jobs:
-  run:
+  build:
     runs-on: self-hosted
 
     steps:
@@ -46,9 +46,3 @@ jobs:
       run: |
         cd runner/src
         ./dev.sh package Release linux-riscv64
-
-    - name: Upload
-      uses: actions/upload-artifact@v4
-      with:
-        name: actions-runner-linux-riscv64
-        path: runner/_package/actions-runner-linux-riscv64-2.311.0.tar.gz
diff --git a/README.md b/README.md
index 18ef8ae..66c4eb9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-# github_actions_riscv
\ No newline at end of file
+# GitHub Actions on RISC-V
+
+This repository provides a guide on how to build and use GitHub Actions (GitHub CI) on Self-Hosted RISC-V CPU machines.
+
+**Disclaimer**: this project is not related to GitHub or .NET development. Any instructions or binary packages published in the spirit of the open source. Use carefully.
+
+## Observed issues
+
+* The workspace is not cleaned
+* `actions/upload-artifact` not working because of disabled Node.js (actually, ARM64 binaries were downloaded)
+
+## How to use
+
+Use a [pre-compiled](https://github.com/dkurt/github_actions_riscv/releases) version or follow the build steps from [build.yaml](.github/workflows/build.yaml).
+Cross-compilation is not supported for now so build process is performed on RISC-V board which takes about 1 hour.
+
+After unpacking the runner archive, install .NET:
+```bash
+cd $HOME
+wget https://github.com/dkurt/dotnet_riscv/releases/download/v8.0.101/dotnet-sdk-8.0.101-linux-riscv64.tar.gz
+
+sudo mkdir /usr/share/dotnet
+cd /usr/share/dotnet
+sudo tar -xf $HOME/dotnet-sdk-8.0.101-linux-riscv64.tar.gz
+```
+
+Verify .NET installation:
+```bash
+./dotnet --info
+```
+
+Then do `./config.sh` and `./run.sh` as recommended in your repository `Settings->Actions->Runners->New self-hosted runner` tab.
+
+Runner was tested on Sipeed Lichee RV Dock with [Ubuntu 23.10](https://ubuntu.com/download/risc-v).