Skip to content

Commit 6f0875a

Browse files
committed
Document upgrade process
1 parent 5dcd834 commit 6f0875a

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,22 @@ In my case I use a [dashbling](https://github.com/pascalw/dashbling) dashboard t
2121
## Installation
2222

2323
1. Download the [latest release](https://github.com/pascalw/kindle-dash/releases) on your computer and extract it.
24-
2. Modify `dist/local/fetch-dashboard.sh` and optionally `dist/local/env.sh`.
25-
3. Copy `dist/` to Kindle, for example: `rsync -vr ./dist kindle:/mnt/us/dashboard`.
24+
2. Modify `local/fetch-dashboard.sh` and optionally `local/env.sh`.
25+
3. Copy the files to the Kindle, for example: `rsync -vr ./ kindle:/mnt/us/dashboard`.
2626
4. Start dashboard with `/mnt/us/dashboard/start.sh`.
2727
Note that the device will go into suspend about 10-15 seconds after you start the dashboard.
2828

29+
## Upgrading
30+
31+
If you're running kindle-dash already and want to update to the latest version follow the following steps.
32+
33+
1. Download the [latest release](https://github.com/pascalw/kindle-dash/releases) on your computer and extract it.
34+
2. Review the release notes. Some releases might require changes to files in `local/`.
35+
3. Copy the files to the Kindle, excluding the `local` directory. For example: `rsync -vur --exclude=local ./ kindle:/mnt/us/dashboard`.
36+
4. Modify files in `/mnt/us/dashboard/local` if applicable.
37+
5. Start dashboard with `/mnt/us/dashboard/start.sh`.
38+
Note that the device will go into suspend about 10-15 seconds after you start the dashboard.
39+
2940
## How this works
3041

3142
* This code periodically downloads a dashboard image from an HTTP(s) endpoint.

0 commit comments

Comments
 (0)