aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 19 insertions, 10 deletions
diff --git a/README.md b/README.md
index 690fdd2..052abe5 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,29 @@
-# Teletext TUI (Swiss Teletext Terminal User Interface)
+# tltxch (Swiss Teletext Terminal Client)
-Python program that fetches (Swiss) teletext from `api.teletext.ch` and displays
-it in the terminal using curses.
+Python program that fetches (Swiss) teletext from `api.teletext.ch` and displays it in the terminal.
+
+## References
+
+- [teletext.ch](https://teletext.ch)
+- API: `https://api.teletext.ch/channels/{channel}/pages/{page}`
+- [ETS 300 706](./res/ets_300706e01p.pdf)
## Usage
-- `c`: switch channel (srf1, srfzwei, srfinfo)
-- `<number><return>`: got to page
-- `h`/`l` go to prev/next page
-- `r` reload page
-- `q` quit
+```
+tltxch.py [--tui] [--channel CHANNEL] [--page PAGE]
+ --tui run in TUI mode.
+ --channel CHANNEL specify channel: srf1 (default), srfzwei, srfinfo.
+ --page page specify page: 100 (default)
+```
+In TUI mode:
+- `q`: quit
+- `n/p`: next/prev page
+- `g`: goto page
## Limitations
-- Graphics are not rendered.
-- Sometimes text is misaligned.
+- Graphics are not rendered properly.
## Example