diff --git a/README.md b/README.md index 34260fd..74e41ad 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,18 @@ Note: Will move more variables to the .env folders soon. .env is under the module folder for now + + +INSTALLATION + + +so basically the steps are pretty simple + +- download the code (clone it or download it and unzip it) +- install python 3.10 on the system +- create a virtual environment using `python -m venv .` in the folder/dir of the code +- activate the environment with `Scripts\activate.bat` on windows or `source bin/activate` on linux +- run pip install to install all the required modules `pip install -r requirements.txt` +- then copy example_env.txt to `.env` in the modules folder +- open that, and put in your info, like openai key or ollama or whatever +- then run `python main.py` to start the whole thing up