diff --git a/README.md b/README.md index c4e2748..01f06aa 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,18 @@ your friendly ai assistant. frontend for ollama. # Installation - git clone repository - install ollama from `https://ollama.ai/download` -- pull a model from ollama (i recommend gemma3n:e4b for weak PCs like mine (i7-10750h + rtx 3050ti laptop edition)) +- pull a model from ollama (i recommend gemma3n:e4b for laptops like mine (i7-10750h + rtx 3050ti laptop edition)) - copy config.example.toml to config.toml and edit it to have the model you selected, optionally set your name in [user] - npm i - node index.js - enjoy + +# Configuration +## Assistant settings +- name = change the name you want the assistant to use for itself. changes it everywhere, including all placeholder text. default is "lydia" +- model = the ollama model you want lydia to use. default is "gemma3n:e4b" +- system_prompt = the system prompt you want lydia to use. +- assistantface = the default face you want lydia to have before waking up. default is "=w=" + +## User settings +- name = the name you want lydia to call you. default is "user"