Mark/restream
1
0
Fork 0
Code Actions Releases Activity

Add instructions to the README on how to build the restream binary using docker

Browse Source
This commit is contained in:
Edgar Merino 2021-02-13 15:52:15 -08:00 committed by Rien Maertens
parent 1585869272
commit 0b919c7764
No known key found for this signature in database
GPG Key ID: AE66CE42F1AF9DEF
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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.