From fd98e1bb1e781f319e12e71225e9bc6d8ae328ff Mon Sep 17 00:00:00 2001
From: Nemo <me@captnemo.in>
Date: Tue, 9 Jun 2020 18:49:07 +0530
Subject: [PATCH] Adds docker and multi-lingual instructions

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 45 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index a62d5dc..4d093f5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # ickabog-ebook ![](https://img.shields.io/badge/Chapters%20Published-21%2F34-brightgreen)
 
-Generates ebooks for The Ickabog by J.K Rowling. Original text from https://www.theickabog.com/. Since the book is still being published, please consider this "in-progress".
+Generates ebooks for The Ickabog by J.K Rowling. Original text from https://www.theickabog.com/. Since the book is still being published, please consider this "in-progress". Supports all 7 languages.
 
 ## Dependencies:
 
@@ -12,8 +12,47 @@ Generates ebooks for The Ickabog by J.K Rowling. Original text from https://www.
 
 ## How to run
 
+### Using Docker
+
+```
+mkdir out
+docker run --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+```
+
+If you'd like to generate for a different language, use the following:
+
+```bash
+mkdir out
+
+# Italiano
+docker run --env LC="it" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+
+# English (US)
+docker run --env LC="en-us" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+
+# España
+docker run --env LC="es" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+
+# Français
+docker run --env LC="fr" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+
+# Deutsch
+docker run --env LC="de" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+
+# Português brasileiro
+docker run --env LC="pt" --volume `pwd`/out:/src/out captn3m0/ickabog-ebook
+```
+
+### Directly
+
 `./generate.sh`
 
+For generating ebooks for a different language, run the script with a LC parameter
+
+`LC=it ./generate.sh`
+
+Various values for LC are: `it, en-us, es, fr, de, pt`. If you don't pass a value, the default (en-GB) is used.
+
 You should have `ickabog.epub`, and `ickabog.pdf` in the `out` directory after the script finishes.
 
 - If you have [ConTeXt][context] installed, you will also get a `out/ickabog-large.pdf` file with large fonts to be kid-friendly.
@@ -22,11 +61,7 @@ You should have `ickabog.epub`, and `ickabog.pdf` in the `out` directory after t
 
 ## Known Issues
 
-The PDF is optimized for few pages of printing, so has a small font size by default. If you'd like a kid-friendly version, [install context][context] to get `ickabog-large.pdf` file.
-
-## Extra
-
-A list of my other EBook generation projects: https://captnemo.in/ebooks/, includes a link to other related projects as well.
+The PDF is optimized for few pages of printing, so has a small font size by default. If you'd like a kid-friendly version, [install context][context] to get `ickabog-large.pdf` file. ConTeXt comes preinstalled in the Docker image, so that's the easiest way to get the same.
 
 ## Credits
 
@@ -36,6 +71,10 @@ The cover art is [Avanyu](http://edan.si.edu/saam/id/object/1979.144.85) by Juli
 
 Code for internationalization and automatic chapter updates via [@lesensei](https://github.com/lesensei/ickabog-ebook/commits/master)'s fork.
 
+## Extra
+
+A list of my other EBook generation projects: https://captnemo.in/ebooks/, includes a link to other related projects as well.
+
 ## License
 
 The little code in this repository is licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.