From c4b247d696c727c1da6d993ce4f6c3a557e91b42 Mon Sep 17 00:00:00 2001 From: imaprogrammer <46126206+nb-programmer@users.noreply.github.com> Date: Sat, 10 Jun 2023 10:25:50 +0530 Subject: [PATCH] Update README.md instructions of .env file Clarified to create a copy of example.env instead of renaming it to prevent accidentally removing from repo --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d21213..5d9bcd3 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,12 @@ pip3 install -r requirements.txt Then, download the LLM model and place it in a directory of your choice: - LLM: default to [ggml-gpt4all-j-v1.3-groovy.bin](https://gpt4all.io/models/ggml-gpt4all-j-v1.3-groovy.bin). If you prefer a different GPT4All-J compatible model, just download it and reference it in your `.env` file. -Rename `example.env` to `.env` and edit the variables appropriately. +Copy the `example.env` template into `.env` +```shell +cp example.env .env +``` + +and edit the variables appropriately in the `.env` file. ``` MODEL_TYPE: supports LlamaCpp or GPT4All PERSIST_DIRECTORY: is the folder you want your vectorstore in