Skip to content

Commit 12c87c6

Browse files
Create kindle-sdk.md
1 parent dbda225 commit 12c87c6

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

kindle-dev/kindle-sdk.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: default
3+
title: Kindle SDK
4+
parent: Kindle Development
5+
---
6+
7+
# Kindle SDK
8+
9+
The Kindle SDK is an unofficial SDK developed by KMC.
10+
It supplants an existing koxtoolchain installation with libraries and pkg-config support.
11+
It is designed to be used with Meson.
12+
13+
## Installation
14+
Once koxtoolchain is installed, the SDK can be installed on top of it as such:
15+
16+
#### 1. Clone the SDK
17+
```sh
18+
git clone --recursive --depth=1 https://github.com/KindleModding/kindle-sdk.git
19+
```
20+
21+
#### 2. Install the SDK for your target
22+
```sh
23+
cd kindle-sdk
24+
chmod +x ./gen-sdk.sh
25+
./gen-sdk.sh <target>
26+
```
27+
Where `<target>` is the same as the toolchain you want to install the SDK for.
28+
29+
| TC | Supported Devices | Target |
30+
|:---------:|:-------------------------------------------:|:--------------------------------:|
31+
| kindle | Kindle 2, DX, DXg, 3 | [not supported by this tutorial] |
32+
| kindle5 | Kindle 4, Touch, PW1 | [not supported by this tutorial] |
33+
| kindlepw2 | Kindle PW2 & everything since on FW <5.16.3 | kindlepw2 |
34+
| kindlehf | Any Kindle on FW >= 5.16.3 | kindlehf |
35+
36+
## Usage
37+
The toolchain is designed to be used with Meson in the following manner:
38+
```sh
39+
meson setup --cross-file <meson_crosscompile_path> builddir_<target>
40+
```
41+
42+
(note that the crosscompile file path is outputted when the sdk installer is run, it will typically be under `~/x-tools/<toolchain>/meson-crosscompile.txt`)
43+
44+
## Additional information
45+
The SDK works by downloading the target firmware from Amazon, copying the libraries into the toolchain's `sysroot` and setting up `.pc` files for pkgconfig on supported libraries

0 commit comments

Comments
 (0)