Skip to content

Commit

Permalink
docs: update firmware-action installation instruction
Browse files Browse the repository at this point in the history
Signed-off-by: AtomicFS <[email protected]>
  • Loading branch information
AtomicFS committed Jan 9, 2025
1 parent bbc46be commit 9647fa2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 24 deletions.
26 changes: 21 additions & 5 deletions docs/src/firmware-action/get_started/04_get_firmware_action.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# Get firmware-action

You can get Firmware-Action multiple ways:
- clone the repository and [build the executable yourself](../usage_local.md)
- download pre-compiled executable from [releases](https://github.com/9elements/firmware-action/releases).
- Arch Linux [AUR package](https://aur.archlinux.org/packages/firmware-action)
- build from source with golang `go install github.com/9elements/firmware-action/cmd/firmware-action@latest`
Firstly, you will need to [install and setup Docker](https://docs.docker.com/engine/install/).

Then you can get firmware-action multiple ways:

## Build from source
Git clone and build, we use [Taskfile](https://taskfile.dev/) as build system, but you can go with just `go build`.
```
git clone https://github.com/9elements/firmware-action.git
cd firmware-action
task build-go-binary
```

## Download executable
Download pre-compiled executable from [releases](https://github.com/9elements/firmware-action/releases).

## Arch Linux
There is [AUR package](https://aur.archlinux.org/packages/firmware-action) available.

## go install
```
go install -v github.com/9elements/firmware-action/cmd/firmware-action@latest
```
21 changes: 2 additions & 19 deletions docs/src/firmware-action/usage_local.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,12 @@
# Local system

To get firmware-action, there are few options:
- download compiled binary executable from [releases](https://github.com/9elements/firmware-action/releases)
- build from source with [taskfile](https://taskfile.dev/)
- `firmware-action` [Arch Linux AUR package](https://aur.archlinux.org/packages/firmware-action)


## Build from source
```
git clone https://github.com/9elements/firmware-action.git
cd firmware-action
task build-go-binary
```


## Arch Linux AUR
For Arch Linux there is also a [AUR package](https://aur.archlinux.org/packages/firmware-action) available.

To get firmware-action loot into [Get firmware-action](get_started/04_get_firmware_action.md) section.

## Run
```
./firmware-action build --config=<path-to-JSON-config> --target=<my-target>
firmware-action build --config=<path-to-JSON-config> --target=<my-target>
```


## Help

```
Expand Down

0 comments on commit 9647fa2

Please sign in to comment.