Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fengalin committed Jan 30, 2024
1 parent f6aeae2 commit e5ce9ca
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

Pre-built packages are available for Linux, macOS and Windows from the
[release page](https://github.com/fengalin/jstation-controller/releases).

Note: the default packages use the `wgpu` backend. If you run into errors, try
the alternative: `glow`.

See the dedicated chapter below if you want to build the application from source.

![jstation-controller UI](assets/screenshot_20230124.png "jstation-controller UI")
Expand Down Expand Up @@ -79,10 +83,18 @@ Minimum dependencies include development libraries for:
#### macOS

If you can test the application on this OS, please open a PR with instructions.
See also the CI workflow.

#### Windows

If you can test the application on this OS, please open a PR with instructions.
See also the CI workflow.

### Features

* `wgpu` (default): use the `wgpu` graphics backend.
* `glow`: use the `glow` graphics backend. Use this backend if you run into
errors using `wgpu`.

### Build

Expand Down

0 comments on commit e5ce9ca

Please sign in to comment.