diff --git a/README.md b/README.md index df34cb3..758d5f8 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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. \ No newline at end of file