summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGrail Finder <wohilas@gmail.com>2025-06-10 12:04:11 +0300
committerGrail Finder <wohilas@gmail.com>2025-06-10 12:05:04 +0300
commit8902893f6ee5ff43738cb8bed1b578adf0c2cd26 (patch)
tree0c22c8d5d836b2612c9675ac5cda04d89de0be43 /README.md
parent412a8347c33d5cf454eac00cee4d7b9ee05749d1 (diff)
Chore: add readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4925eda..56a4d32 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-#### tui with middleware for LLM use
+### gf-lt (grail finder's llm tui)
+Terminal program to chat with llm.
+
+#### Has/Supports
+- card protocol;
+- /completion (fill) and openai's /v1/chat/completion (chat);
+- llama.cpp api, deepseek (other ones were not tested);
+- showing images (not really, for now only if your char card is png it could show it);
+- tts/sst (if whisper.cpp server / fastapi tts server are provided);
+
+#### usage examples
+[!usage example](assets/usage_ex_01.png)
+place a gif here
+and/or link to video
+
+#### how to install
+```
+git clone <url>
+cd gf-lt
+make
+```
+
+#### setting up config