about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMalte Voos <git@mal.tc>2025-02-19 21:25:58 +0100
committerMalte Voos <git@mal.tc>2025-02-19 21:25:58 +0100
commitaa6997763f5d5d6a86dca2b22a453b7d6c41ea92 (patch)
tree26498e47d7c0159799d63cf9ebf3a132d6af0a67
parent0b2391075932d3b78a4e700cd464f068874b6127 (diff)
downloadreMder-aa6997763f5d5d6a86dca2b22a453b7d6c41ea92.tar.gz
reMder-aa6997763f5d5d6a86dca2b22a453b7d6c41ea92.zip
update README
-rw-r--r--README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/README.md b/README.md
index 45b3933..cddd2bb 100644
--- a/README.md
+++ b/README.md
@@ -6,21 +6,18 @@ 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.11.2.5.
+Currently, reMder uses firmware version v3.14.1.9.
 
 ## Building
 
-reMder is provided as a Nix package, ready to be installed using the Nix
-package manager (available at https://nixos.org/download/). After having
-cloned this repo, run
+Use the nixpkgs overlay provided by the flake. You need a nixpkgs that has
+https://github.com/NixOS/nixpkgs/pull/381224 merged.
 
-```
-$ nix build
-```
+TODO expand instructions for non-Nix users
 
-This will build Linux for the emulator and a GCC cross-compiler, so be patient
-:) After this command has finished, reMder should be available in
-`./result/bin`.
+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.
 
 ## Usage