From 69140e9c5cb4a92f788437f191b91ee2c8888b75 Mon Sep 17 00:00:00 2001 From: lyx0 <66651385+lyx0@users.noreply.github.com> Date: Tue, 5 Mar 2024 19:59:56 +0100 Subject: [PATCH] update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ecea260..5fc219b 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,16 @@ Twitch chat bot that interacts with ollama. Work in Progress. ## Requirements: -Go +[Golang](https://go.dev/) [Ollama.com](https://ollama.com) ## Build and run: -1. Change the default values in the provided `env.example` and rename it to `.env`. -2. Make sure ollama is up and running on the host. -3. With docker compose: -* `$ make up` -3. Without docker: -* `$ make build && make run` -4. Join the Twitch channel you chose and use `()gpt ` +1. Change the example values in the provided `env.example` and rename it to `.env`. +2. Make sure ollama is running on the host and reachable at `localhost:11434` and the model that you specified in the `.env` file is already downloaded and ready to go. (Can be checked with e.g. `ollama run wizard-vicuna-uncensored`) +3. Run: + - With docker compose (might need sudo infront if you haven't setup rootless): + - `$ make up` + - Without docker: + - `$ make build && make run` +4. Join the Twitch channels you chose and type `()gpt ` and hopefully get a response.