aboutsummaryrefslogtreecommitdiff
path: root/ui/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'ui/__init__.py')
-rw-r--r--ui/__init__.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/ui/__init__.py b/ui/__init__.py
new file mode 100644
index 0000000..4986a10
--- /dev/null
+++ b/ui/__init__.py
@@ -0,0 +1,9 @@
+"""The TUI frontend for the audiobook generator.
+
+``ui.tui`` is the DOS-style curses widget library, and ``ui.hub`` is the
+main menu the user sees when running ``audiobook.py`` with no arguments
+(set up/configure backends, convert the input directory). It is the only
+entry point for the interactive workflow; everything else under
+``backends/`` and ``converter/`` is library code driven by it or by the
+``audiobook.py`` CLI flags.
+"""