add README

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5435505
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# LLEAP
+
+stands for Language LEArning Player. It's basically a clone of Language
+Reactor aka Language Learning with Netflix, but it is designed to play
+HTTP streams or local files from your computer. Implemented using Relm4
+(gtk4+libadwaita), gstreamer and ffmpeg.
+
+Currently this is alpha-quality software with probably a good number of bugs.
+
+## Features
+- can display multiple subtitle tracks concurrently
+- can extract subtitles from audio using whisper-cpp
+- can auto-translate subtitles using the DeepL api
+
+## Known bugs
+- sometimes the file won't start playing after pressing "play"
+- the program will probably behave weirdly when opening several files after each other
+- something goes wrong with the URL printing/parsing when opening files with mildly funny characters (whitespace?)
+
+## TODOs
+- make whisper model path, maybe also other arguments configurable
+- implement key bindings
+- specify source language in deepl api calls
+- make target language for machine translation configurable
+- implement dictionary lookup for single words
+- allow specifying file/url on the conmmand line
+
+## Wishlist
+- LLM integration for grammar explanations etc