From fb080e031f3087ebdb3c5eb67f7fad43bb53e114 Mon Sep 17 00:00:00 2001 From: Patrick Gaskin Date: Sat, 18 Jul 2020 20:35:20 -0400 Subject: [PATCH] Updated build instructions in README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b815433..6d74204 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ To uninstall NickelMenu, just create a new file named `uninstall` in `.adds/nm/` Most errors, if any, will be displayed as a menu item in the main menu in the top-left corner of the home screen. If no new menu entries appear here after a reboot, try reinstalling NickelMenu. If that still doesn't work, connect over telnet or SSH and check the output of `logread`. ## Compiling -[@NiLuJe](https://github.com/NiLuJe)'s [toolchain](https://github.com/koreader/koxtoolchain) and [sysroot](https://svn.ak-team.com/svn/Configs/trunk/Kindle/Misc/kobo-nickel-sysroot.sh) are required to compile NickelMenu. They can also be found as a [Docker image](https://hub.docker.com/r/geek1011/kobo-toolchain). To compile NickelMenu, just run `make all koboroot` with the toolchain in your PATH, or use `docker run --volume="$PWD:$PWD" --user="$(id --user):$(id --group)" --workdir="$PWD" --env=HOME --entrypoint=make --rm -it geek1011/kobo-toolchain all koboroot` with the Docker image. + +NickelTC is designed to be compiled with [NickelTC](https://github.com/pgaskin/NickelTC). To compile it with Docker/Podman, use `docker run --volume="$PWD:$PWD" --user="$(id --user):$(id --group)" --workdir="$PWD" --env=HOME --entrypoint=make --rm -it docker.io/geek1011/nickeltc:1.0 all koboroot`. To compile it on the host, use `make CROSS_COMPILE=/path/to/nickeltc/bin/arm-nickel-linux-gnueabihf-`.