1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..536f2f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+Magic Kindle
+===
+
+Kindle 4 NT hacked to show the Magic Mirror 2 as screensaver.
+
+<img src="demo.jpg" height="300" />
+
+Server Setup
+---
+
+  * Install MagicMirror on localhost, for example in Docker: https://magicmirror.builders/
+  * Install modules, for example a slideshow: https://github.com/roramirez/MMM-ImagesPhotos
+  * Configure MagicMirror and its modules, for example as in `./magicmirror/config`. Avoid transitions and colors.
+  * Customize the CSS, for example as in `./magicmirror/css`.
+  * Install the dependencies of `./magiccapture` and Chromium.
+  * Make sure that the URL in `./magiccapture/index.js` points to the MagicMirror address.
+  * Set up a cron job to run `./magiccapture/run.sh`.
+  * Use a web server and make `./magiccapture/screenshot/screenshot.png` accessible to the network the Kindle will be connected to.
+  * Start MagicMirror, run the cron job and verify that a black/white PNG is being served.
+
+Kindle Setup
+---
+
+  * Get a Kindle 4. This setup was tested on firmware 4.1.3.
+  * Install the jailbreak and USBNetworking, the screensaver hack is not needed: https://wiki.mobileread.com/wiki/Kindle4NTHacking
+  * Install the MKK and KUAL: https://www.mobileread.com/forums/showthread.php?t=203326
+  * Move `./magickindle/` to the Kindle at `/extensions/`.
+  * Change the URL in `./magickindle/bin/start.sh` so that it points to the web server.
+  * Optionally, customize the `rtcWakeup` time. The length of the interval has a significant impact on how long the battery lasts, as the Kindle only consumes power for the one minute wakeup.
+  * Navigate to the KUAL application on the Kindle and start the Magic Kindle extension.
+  * Press the power button to activate the screensaver which triggers the Magic Kindle script.
+
+Enclose the Kindle in a fitting photo frame. Charge it once a month. If it does not turn on, press the power button for a minute and press it again for 10 seconds to force a reboot.