about summary refs log tree commit diff
path: root/rfcToKindle/README.md
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-02-02T18·32+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-02-02T18·54+0000
commit916e46d7ceafaf7584c80851553a0f673fc9d1b9 (patch)
tree0b73212fe3e9d5229abc34170169aef4ef12b6db /rfcToKindle/README.md
parent4de3e5c39286553df5946327681d0fb814ae235b (diff)
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.
Diffstat (limited to 'rfcToKindle/README.md')
-rw-r--r--rfcToKindle/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/rfcToKindle/README.md b/rfcToKindle/README.md
new file mode 100644
index 000000000000..e7b4fa841ef6
--- /dev/null
+++ b/rfcToKindle/README.md
@@ -0,0 +1,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