Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update firmware-action installation instruction #496

Merged
merged 1 commit into from
Jan 9, 2025
Merged

docs: update firmware-action installation instruction #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions docs/src/firmware-action/get_started/04_get_firmware_action.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading