diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 9 insertions, 14 deletions
@@ -6,35 +6,30 @@ interface's PDF rendering functionality to render your documents. As a result, it should be able to render any reMarkable document, in particular those created on newer firmware versions. -Currently, reMder uses firmware version v3.20.0.92. +Currently, reMder uses firmware version v3.27.1.0. ## Building -Use the nixpkgs overlay provided by the flake. You need a nixpkgs that has -https://github.com/NixOS/nixpkgs/pull/381224 merged. - -TODO expand instructions for non-Nix users - -Moreover, at the moment reMder runs only on 64-bit ARM processors that can -execute 32-bit ARM instructions (e.g. the Cortex-A72 found on the Raspberry -Pi 4B.) I'll add support for more platforms when I find the time. +``` +$ nix build +``` ## Usage First, run ``` -$ reMder-server & +$ result/bin/reMder-server & ``` -This will boot up an emulated reMarkable in QEMU, with its disk image at -./reMder.qcow2. The reMarkable's SSH server will be accessible on the host at -localhost:43922 and the USB web inteface at localhost:43980. +This will boot up an emulated reMarkable in QEMU. The reMarkable's SSH server +will be accessible on the host at localhost:43922 and the USB web inteface at +localhost:43980. After reMder-server has initialized, use ``` -$ reMder-client test.(rmdoc/zip) test.pdf +$ result/bin/reMder-client test.(rmdoc/zip) test.pdf ``` to render documents to PDF. |