tvl-depot/rfcToKindle/README.md
William Carroll 916e46d7ce Support script to download RFCs to my Kindle
Today I learned that you can email your Kindle files to read them using the
paperwhite display. I'm attempting to read RFCs, so after reading 1/4 of the way
through RFC6479 (on OAuth2.0), I realized that it might be easier to read on my
Kindle instead of on my computer screen. Out of this, rfcToKindle.go was born.

I'm not sure if I'd like to publish this or not.
2020-02-02 18:54:26 +00:00

30 lines
821 B
Markdown

# 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