From 9647fa2871e069e1aab53f31920bfe831317a42f Mon Sep 17 00:00:00 2001 From: AtomicFS Date: Wed, 8 Jan 2025 22:50:16 +0100 Subject: [PATCH] docs: update firmware-action installation instruction Signed-off-by: AtomicFS --- .../get_started/04_get_firmware_action.md | 26 +++++++++++++++---- docs/src/firmware-action/usage_local.md | 21 ++------------- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/src/firmware-action/get_started/04_get_firmware_action.md b/docs/src/firmware-action/get_started/04_get_firmware_action.md index 155a5621..41a992a1 100644 --- a/docs/src/firmware-action/get_started/04_get_firmware_action.md +++ b/docs/src/firmware-action/get_started/04_get_firmware_action.md @@ -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 +``` diff --git a/docs/src/firmware-action/usage_local.md b/docs/src/firmware-action/usage_local.md index e0d6d19d..1841a83e 100644 --- a/docs/src/firmware-action/usage_local.md +++ b/docs/src/firmware-action/usage_local.md @@ -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= --target= +firmware-action build --config= --target= ``` - ## Help ```