ickabog-ebook/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

2020-06-09 08:24:36 +00:00
# ickabog-ebook ![](https://img.shields.io/badge/Chapters%20Published-21%2F34-brightgreen)
2020-05-28 19:43:58 +00:00
2020-06-05 20:52:21 +00:00
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".
2020-05-28 19:43:58 +00:00
## Dependencies:
- `wget`
- [`pup`](https://github.com/ericchiang/pup)
- [`pandoc`](https://pandoc.org/)
2020-05-29 23:15:28 +00:00
- [`pdftk`]
2020-05-28 19:43:58 +00:00
## How to run
`./generate.sh`
2020-05-28 19:59:29 +00:00
You should have `ickabog.epub`, and `ickabog.pdf` in your directory after the script finishes. If you have [ConTeXt](https://wiki.contextgarden.net/Main_Page) installed, you will also get a `ickabog-large.pdf` file with large fonts to be kid-friendly.
2020-05-28 19:43:58 +00:00
2020-05-28 19:59:29 +00:00
## Known Issues
2020-05-28 19:43:58 +00:00
2020-05-28 19:59:29 +00:00
2. 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 to get `ickabog-large.pdf` file.
## Extra
2020-05-29 23:15:28 +00:00
A list of my other EBook generation projects: https://captnemo.in/ebooks/, includes a link to other related projects as well.
## Credits
The cover art is [Avanyu](http://edan.si.edu/saam/id/object/1979.144.85) by Julian Martinez. Used under Creative Commons license.
> Julian Martinez, Avanyu, ca. 1923, watercolor, ink, and pencil on paper, Smithsonian American Art Museum, Corbin-Henderson Collection, gift of Alice H. Rossin, 1979.144.85
2020-05-28 19:43:58 +00:00
## License
2020-05-29 23:15:28 +00:00
The little code in this repository is licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.