Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
Signed-off-by: AtomicFS <[email protected]>
  • Loading branch information
AtomicFS committed Dec 4, 2024
1 parent 2726c85 commit ef81b06
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,24 @@ Example usage of [firmware-action](https://github.com/9elements/firmware-action)

## How to use

Firstly, install `firmware-action` as [described in documentation](https://9elements.github.io/firmware-action/firmware-action/get_started/04_get_firmware_action.html).

### Simple example

If running ArchLinux replace `task` with `go-task`.
```bash
git clone --depth 1 [email protected]: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 [email protected]: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
```

0 comments on commit ef81b06

Please sign in to comment.