Skip to content

Commit

Permalink
Clearify state of rM 2 support in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LinusCDE committed Jan 3, 2021
1 parent 6f1b5e6 commit e7f6238
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# chessMarkable

[![rm1](https://img.shields.io/badge/rM1-supported-green)](https://remarkable.com/store/remarkable)
[![rm2](https://img.shields.io/badge/rM2-only_with_shim-orange)](https://remarkable.com/store/remarkable-2)
[![rm2](https://img.shields.io/badge/rM2-needs_shim_or_launcher-yellow)](https://remarkable.com/store/remarkable-2)
[![opkg](https://img.shields.io/badge/OPKG-chessmarkable-blue)](https://github.com/toltec-dev/toltec)
[![launchers](https://img.shields.io/badge/Launchers-supported-green)](https://github.com/reHackable/awesome-reMarkable#launchers)
[![Mentioned in Awesome reMarkable](https://awesome.re/mentioned-badge.svg)](https://github.com/reHackable/awesome-reMarkable)
Expand Down Expand Up @@ -50,7 +50,9 @@ The reverse can also be done. Running chessmarkable with `-i` set to a FEN, will

## reMarkable 2 support

The inputs are fully working on the reMarkable 2. The framebuffer is still a work in progress, however it can be run by using [this shim](https://github.com/ddvk/remarkable2-framebuffer#framebuffer-client-shim). The game may be a bit less performant with it as not all refresh modes are figured out, but it'll work.
Chessmarkable supports the input of the reMarkable 2 natively but not the framebuffer. For that [this shim](https://github.com/ddvk/remarkable2-framebuffer/) has to be used (or you won't get an image). Luckily current launchers support automaticially launching apps through the shim. So if you use a launcher (oxide or remux), it should just work.

Though, since the framebuffer uses a shim, specific refresh optimization may not apply to the reMarkable 2 and perform a bit worse there (but this is probably nitpicky anyway).

## Credit

Expand Down

0 comments on commit e7f6238

Please sign in to comment.