summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrail Finder <wohilas@gmail.com>2025-06-11 11:41:11 +0300
committerGrail Finder <wohilas@gmail.com>2025-06-11 11:41:11 +0300
commitfee5b4f506a5285316c54513fa370eeb1aeb4401 (patch)
tree3656174b3b60530607b107e1ac30f855e384ec13
parentc2da07ddc31440c0fdb129e108544f921436b3f1 (diff)
Chore: readme update
-rw-r--r--README.md13
-rw-r--r--assets/ex01.pngbin0 -> 68793 bytes
2 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 56a4d32..03d538b 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,23 @@
Terminal program to chat with llm.
#### Has/Supports
-- card protocol;
-- /completion (fill) and openai's /v1/chat/completion (chat);
+- character card spec;
- 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
+[!usage example](assets/ex01.png)
#### how to install
+clone the project
```
-git clone <url>
cd gf-lt
make
```
#### setting up config
+```
+cp config.example.toml config.toml
+```
+set values as you need them to be.
diff --git a/assets/ex01.png b/assets/ex01.png
new file mode 100644
index 0000000..1fca28f
--- /dev/null
+++ b/assets/ex01.png
Binary files differ