-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update firmware-action installation instruction
Signed-off-by: AtomicFS <[email protected]>
- Loading branch information
Showing
2 changed files
with
23 additions
and
24 deletions.
There are no files selected for viewing
26 changes: 21 additions & 5 deletions
26
docs/src/firmware-action/get_started/04_get_firmware_action.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters