about summary refs log tree commit diff
path: root/tools/rfcToKindle/README.md
blob: e7b4fa841ef6f4c7f76310bc600c47057af6385a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# rfcToKindle

Wirelessly transfer RFC documents to your Kindle to device for an alternative
medium for reading.

## Installation

`rfcToKindle` makes use of [`buildGo.nix`][2] to package itself.  If you're
using [Nix][1], you can install `rfcToKindle` using `nix-env`:

```shell
> nix-env -f https://github.com/wpcarro/rfcToKindle -i
```

## Usage

```shell
> rfcToKindle -document rfc6479 -recipient username@kindle.com
```

## Dependencies

This uses `sendgmr` to send the file to the Kindle. Make sure:
1. That `sendgmr` is installed and available on $PATH.
2. That it is configured to work with your preferred email address.
3. That the email address `sendgmr` is configured to use is whitelisted in
   your Kindle "Personal Document Settings".

[1]: https://nixos.org/nix/
[2]: https://git.tazj.in/tree/nix/buildGo