Skip to content

Commit 0caca66

Browse files
committed
Add some more info to README
1 parent 549d4f8 commit 0caca66

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

README.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
1-
# Kindle dashboard
1+
# Low-power Kindle dashboard
2+
3+
Turns out old Kindle devices make great, energy efficient dashboards :-)
4+
5+
![](./example/photo.jpg)
6+
7+
## What this repo is
8+
9+
This repo only contains the code that runs on the Kindle. It periodically fetches an image to be displayed on the screen and suspends the device to RAM (which is very power efficient) until the next screen update.
10+
11+
This tool _does not_ render the dashboard itself. It's expected that what to display on the screen is rendered elsewhere and can be fetchd via HTTP(s). This is both more power efficient and allows you to use any tool you like to produce the dashboard image.
12+
13+
In my case I use a [dashbling](https://github.com/pascalw/dashbling) dashboard that I render into a PNG screenshot on a server.
14+
15+
## Prerequisites
16+
17+
* A jailbroken Kindle, with Wi-Fi configured.
18+
* Tested only on a Kindle 4 NT. Should work on other Kindle devics as well with minor modifications.
19+
20+
## Installation
221

322
1. Download the [latest release](https://github.com/pascalw/kindle-dash/releases) on your computer and extract it.
4-
2. Modify `dist/local/fetch-dashboard.sh`and optionally `dist/local/env.sh`.
23+
2. Modify `dist/local/fetch-dashboard.sh` and optionally `dist/local/env.sh`.
524
3. Copy `dist/` to Kindle, for example: `rsync -vr ./dist kindle:/mnt/us/dashboard`.
6-
4. Start dashboard with `/mnt/us/dashboard/start.sh`.
25+
4. Start dashboard with `/mnt/us/dashboard/start.sh`.
26+
Note that the device will go into suspend about 10-15 seconds after you start the dashboard.
27+
28+
## Credits
29+
30+
Thanks to [davidhampgonsalves/life-dashboard](https://github.com/davidhampgonsalves/life-dashboard) for the inspiration!

example/photo.jpg

458 KB
Loading

0 commit comments

Comments
 (0)