From 86610263193d3880711e8d45635362f9a462a1f3 Mon Sep 17 00:00:00 2001 From: A Holt Date: Sat, 5 Aug 2023 08:01:51 -0400 Subject: [PATCH] calibre-web/README.rst: Overhaul intro --- roles/calibre-web/README.rst | 45 +++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/roles/calibre-web/README.rst b/roles/calibre-web/README.rst index dfc34c648..8e816ef14 100644 --- a/roles/calibre-web/README.rst +++ b/roles/calibre-web/README.rst @@ -13,26 +13,39 @@ Calibre-Web README ================== -Calibre-Web provides a clean interface for browsing, reading and downloading -e-books using a `Calibre database `_. -Teachers can upload e-books, adjust e-book metadata, and create custom e-book -collections ("bookshelves"): +This Ansible role installs +`Calibre-Web `_ as a modern +client-server alternative to Calibre, for your +`Internet-in-a-Box (IIAB) `_. -https://github.com/janeczku/calibre-web#about +Calibre-Web provides a clean web interface for students to browse, read and +download e-books using a +`Calibre-compatible database `_. -This Ansible role installs Calibre-Web, as a modern alternative to -`Calibre `_, -for your Internet-in-a-Box (IIAB). +Teachers upload e-books, adjust e-book metadata, and create custom "bookshelf" +collections — to help students build the best local library! -*NOTE: Calibre-Web takes advantage of Calibre's own* -`/usr/bin/ebook-convert `_ -*program if that's installed — so consider also installing Calibre during your -IIAB installation — if you tolerate the weighty ~1 GB (of graphical OS -libraries) that Calibre mandates!* +.. image:: https://www.yankodesign.com/images/design_news/2019/05/221758/luo_beetle_library_8.jpg -Please note Calibre-Web's Ansible playbook is -``/opt/iiab/iiab/roles/calibre-web`` whereas its Ansible variables -``calibreweb_*`` do **not** include the dash. +🍒 GURU TIPS 🍒 + +* Calibre-Web takes advantage of Calibre's own `/usr/bin/ebook-convert + `_ program + if that's installed — so consider also installing + `Calibre `_ during your IIAB + installation — *if you tolerate the weighty ~1 GB (of graphical OS libraries) + that Calibre mandates!* + +* If you choose to also install Calibre (e.g. by running + ``sudo apt install calibre``) then you'll get useful e-book + importing/organizing tools like + `/usr/bin/calibredb `_. + +* WARNING: Calibre-Web's Ansible playbook is + ``/opt/iiab/iiab/roles/calibre-web`` whereas its Ansible variables (in + `/etc/iiab/local_vars.yml + `_) + ``calibreweb_*`` do **not** include the dash. Using It --------