Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Thanh Thai <[email protected]>
  • Loading branch information
FuLygon committed Jun 7, 2024
1 parent 32e38b9 commit 810054c
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@

Unofficial media conversion tool for **SR Studio Radiance65** keyboard screen.

Based on the official app which only support Windows operating system.

## Download

[![release](https://img.shields.io/github/release/FuLygon/sr65-app.svg?style=flat)](https://github.com/FuLygon/sr65-app/releases)

## Supported media formats
- Image: png, jpg/jpeg, gif
- Video: mp4
- Image: `png`, `jpg/jpeg`, `gif`
- Video: `mp4`

## Build from source
Make sure [go](https://go.dev) is installed.
Expand All @@ -24,7 +22,7 @@ git clone https://github.com/FuLygon/sr65-app.git
cd sr65-app
```

- Copy `ffmpeg` binary to `embed/bin` directory if you want to embed it when building. This is optional.
- Copy `ffmpeg` binary to `embed/bin` directory if you want to embed it when building (optional)

- Build the app
```shell
Expand All @@ -33,6 +31,7 @@ go build

## Note
- For configuring keyboard feature such as keymap, macros, layout, etc... refer to [Vial](https://get.vial.today) instead.
- Dynamic media content such as gif, mp4 heavily rely on `ffmpeg` for converting.
- Released binary were embedded with `ffmpeg` by default for all OS with `amd64` architecture. For `arm64` architecture, only `linux` version were embedded. For `windows` and `darwin` version with `arm64` architecture, make sure to have `ffmpeg` installed and added to system `PATH`. This is completely optional if you don't need to convert dynamic media content.
- Video conversion heavily rely on `ffmpeg`. GIF conversion can be converted using built-in function or `ffmpeg` if `ffmpeg` is available.
- Released binary were embedded with `ffmpeg` by default for all OS with `amd64` architecture. For `arm64` architecture, only `linux` version were embedded. For `windows` and `darwin` version with `arm64` architecture, make sure to have `ffmpeg` installed and added to system `PATH`. This is only necessary for converting video or GIF using
`ffmpeg`.
- Antivirus software may flag released binary as malicious. This is a **false positive**. You can [build the app from source](#build-from-source) as an alternative.

0 comments on commit 810054c

Please sign in to comment.