From e0b5a8cc2f7271e8d3c5dd1593c2e7f4827b8527 Mon Sep 17 00:00:00 2001 From: AtomicFS Date: Mon, 25 Nov 2024 15:33:05 +0100 Subject: [PATCH] docs: update README Signed-off-by: AtomicFS --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cc37dc..2a802ad 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,22 @@ Example usage of [firmware-action](https://github.com/9elements/firmware-action) ## How to use +### Simple example + +If running ArchLinux replace `task` with `go-task`. +```bash +git clone --depth 1 git@github.com:9elements/firmware-action-example.git +cd firmware-action-example +git submodule update --depth 1 --init --recursive +task build:coreboot +``` + +### Complex example + +If running ArchLinux replace `task` with `go-task`. ```bash git clone --depth 1 git@github.com:9elements/firmware-action-example.git cd firmware-action-example git submodule update --depth 1 --init --recursive -firmware-action build --config=firmware-action.json --target=coreboot-example +task build:coreboot-linuxboot:recursive ```