update README.md

This commit is contained in:
lyx0 2024-03-05 19:59:56 +01:00
parent cbd350fce7
commit 69140e9c5c

View file

@ -3,15 +3,16 @@
Twitch chat bot that interacts with ollama. Work in Progress. Twitch chat bot that interacts with ollama. Work in Progress.
## Requirements: ## Requirements:
Go [Golang](https://go.dev/)
[Ollama.com](https://ollama.com) [Ollama.com](https://ollama.com)
## Build and run: ## Build and run:
1. Change the default values in the provided `env.example` and rename it to `.env`. 1. Change the example values in the provided `env.example` and rename it to `.env`.
2. Make sure ollama is up and running on the host. 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. With docker compose: 3. Run:
* `$ make up` - With docker compose (might need sudo infront if you haven't setup rootless):
3. Without docker: - `$ make up`
* `$ make build && make run` - Without docker:
4. Join the Twitch channel you chose and use `()gpt <cool query>` - `$ make build && make run`
4. Join the Twitch channels you chose and type `()gpt <cool query>` and hopefully get a response.