readme stub

README.md

@@ -0,0 +1,77 @@
+# Unofficial reMarkable Linux Kernel
+
+***UNDER DEVELOPMENT***
+
+This kernel is for the reMarkable2 epaper tablet.
+
+# Differences
+This is a small fork of the upstream reMarkable kernel from the manufacturer.
+
+* Adds kernel patch from here:
+https://remarkablewiki.com/tech/rm2_otg_pogo
+
+# Build
+Build thine kernel thusly:
+
+```
+git clone https://spacecruft.org/redonkable/alistair23-linux
+cd alistair23-linux
+# should already be on this branch, but check it out:
+git checkout redonkable
+# XXX confirm which defconfig is best
+ARCH=arm CROSS_COMPILE=arm-none-eabi- make zero-sugar_defconfig
+ARCH=arm CROSS_COMPILE=arm-none-eabi- make -j`nproc`
+ARCH=arm CROSS_COMPILE=arm-none-eabi- make modules_install INSTALL_MOD_PATH=./tmp
+rm -rf tmp/lib/modules/*/build tmp/lib/modules/*/source
+```
+
+Install files thusly. Symlink them later, or change `fw_env` variables.
+
+```
+# Kernel modules
+scp -pr tmp/lib/modules/* root@10.11.99.1:/lib/modules/
+# Kernel
+# XXX Update kernel version number
+scp -p arch/arm/boot/zImage root@10.11.99.1:/boot/zImage-4.14.78
+# DTB
+# XXX Update kernel version number
+scp -p arch/arm/boot/dts/zero-sugar.dtb  root@10.11.99.1:/boot/zero-sugar.dtb-4.14.78
+```
+
+Log in and set symlinks to new kernel seteup.
+
+```
+ssh root@10.11.99.1
+
+cd /boot
+mv zImage zImage.bak
+# XXX Update kernel version number
+ln -s zImage-4.14.78 zImage
+mv zero-sugar.dtb zero-sugar.dtb.bak
+# XXX Update kernel version number
+ln -s zero-sugar.dtb-4.14.78 zero-sugar.dtb
+
+cd /lib/modules
+# XXX Update kernel version number
+mv 4.14.78 4.14.78.bak
+# Note, git tag may vary, something like:
+# XXX Update kernel version number
+ln -s 4.14.78-g2682167b2d00-dirty 4.14.78
+```
+
+Then power off, power back up.
+
+# See Also
+
+* https://remarkablewiki.com/tech/rm2_otg_pogo
+* https://remarkablewiki.com/tech/kernel
+* https://remarkablewiki.com/tech/updatingkernel
+* https://remarkablewiki.com/tech/filesystem
+* https://github.com/ddvk/remarkable2-recovery
+
+
+# Fork
+This is a fork of the alistair23 reMarkable Linux kernel from this repository:
+
+* https://github.com/alistair23/linux
+