From 0b919c7764f3fae7525a147b72b7fb20bec259dc Mon Sep 17 00:00:00 2001 From: Edgar Merino Date: Sat, 13 Feb 2021 15:52:15 -0800 Subject: [PATCH] Add instructions to the README on how to build the restream binary using docker --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f5d9c0..844c1a2 100644 --- a/README.md +++ b/README.md @@ -167,4 +167,18 @@ Steps you can try if the script isn't working: ## Development -If you want to play with the `restream` code, you will have to [install Rust](https://www.rust-lang.org/learn/get-started) and [setup the reMarkable toolchain](https://github.com/canselcik/libremarkable#setting-up-the-toolchain) to do cross-platform development. +If you want to play with the `restream` code, you will have to [install Rust](https://www.rust-lang.org/learn/get-started). + +There are two ways of building the required restream binary for streaming the reMarkable framebuffer. For both approaches, the generated restream binary will be located under `target/armv7-unknown-linux-gnueabihf/release/restream`. + +- Using docker and the toltec toolchain + +You can use the [toltec toolchain docker images](https://github.com/toltec-dev/toolchain) to build a restream binary compatible with the reMarkable. + +``` +docker run --rm -v $(pwd):/project -v /project/.cargo -w "/project" ghcr.io/toltec-dev/rust:latest cargo build --release --target=armv7-unknown-linux-gnueabihf +``` + +- Using the reMarkable toolchain + +[Setup the reMarkable toolchain](https://github.com/canselcik/libremarkable#setting-up-the-toolchain) to do cross-platform development.