Chore: readme update
This commit is contained in:
13
README.md
13
README.md
@@ -2,22 +2,23 @@
|
|||||||
Terminal program to chat with llm.
|
Terminal program to chat with llm.
|
||||||
|
|
||||||
#### Has/Supports
|
#### Has/Supports
|
||||||
- card protocol;
|
- character card spec;
|
||||||
- /completion (fill) and openai's /v1/chat/completion (chat);
|
|
||||||
- llama.cpp api, deepseek (other ones were not tested);
|
- 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);
|
- 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);
|
- tts/sst (if whisper.cpp server / fastapi tts server are provided);
|
||||||
|
|
||||||
#### usage examples
|
#### usage examples
|
||||||
[!usage example](assets/usage_ex_01.png)
|
[!usage example](assets/ex01.png)
|
||||||
place a gif here
|
|
||||||
and/or link to video
|
|
||||||
|
|
||||||
#### how to install
|
#### how to install
|
||||||
|
clone the project
|
||||||
```
|
```
|
||||||
git clone <url>
|
|
||||||
cd gf-lt
|
cd gf-lt
|
||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
#### setting up config
|
#### setting up config
|
||||||
|
```
|
||||||
|
cp config.example.toml config.toml
|
||||||
|
```
|
||||||
|
set values as you need them to be.
|
||||||
|
|||||||
BIN
assets/ex01.png
Normal file
BIN
assets/ex01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Reference in New Issue
Block a user