summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2023-03-14 06:39:12 +0100
committertechknowlogick <techknowlogick@noreply.gitea.io>2023-03-14 06:39:12 +0100
commitc0c363bf59627d881514ae25964e07e23b898c7c (patch)
tree4df5b7010fd28cfa5b92728f52cbd5d9271c1814 /README.md
parentInject version when building and report version to Gitea via log and header (... (diff)
downloadforgejo-runner-c0c363bf59627d881514ae25964e07e23b898c7c.tar.xz
forgejo-runner-c0c363bf59627d881514ae25964e07e23b898c7c.zip
Update readme to add pre-built binary download links (#45)
Reviewed-on: https://gitea.com/gitea/act_runner/pulls/45 Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index b5cf959..0449ec3 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,25 @@
# act runner
-Act runner is a runner for Gitea based on [act](https://gitea.com/gitea/act).
+Act runner is a runner for Gitea based on [Gitea fork](https://gitea.com/gitea/act) of [act](https://github.com/nektos/act) .
-## Prerequisites
+## Installation
+
+### Prerequisites
Docker Engine Community version is required. To install Docker CE, follow the official [install instructions](https://docs.docker.com/engine/install/).
-## Quickstart
+### Download pre-built binary
+
+Visit https://dl.gitea.com/act_runner/ and download the right version for your platform.
-### Build
+### Build from source
```bash
make build
```
+## Quickstart
+
### Register
```bash
@@ -58,4 +64,4 @@ If the registry succeed, it will run immediately. Next time, you could run the r
```bash
./act_runner daemon
-``` \ No newline at end of file
+```