Complement readme.
This commit is contained in:
parent
ee7ff54fbf
commit
d1eab69d74
1 changed files with 18 additions and 0 deletions
18
README.md
18
README.md
|
@ -2,6 +2,24 @@
|
|||
|
||||
LLM service over TCP with shared context.
|
||||
|
||||
## Usage
|
||||
|
||||
### Dependencies
|
||||
|
||||
- `deno` Typescript runtime used for the project, install it using your package manager.
|
||||
- `ollama` Local LLM service used to run chats, install it using your package manager.
|
||||
- `llama3.2` Language Model used for chats, you can install it using `ollama pull llama3.2`.
|
||||
|
||||
### Running
|
||||
|
||||
> kub requires the ollama service to be active, either start it manually with `ollama serve` or enable its systemd
|
||||
> service `sudo systemctl enable --now ollama.service`
|
||||
|
||||
```sh
|
||||
$ ./src/kub.ts
|
||||
# Listening on port 8080
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Colored chat.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue