github/max_headroom
1
0
Fork 0
mirror of https://github.com/maglore9900/max_headroom.git synced 2025-06-06 03:25:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
maglore9900 2024-10-01 17:44:19 -04:00
parent af98c5fae2
commit 20378f9d3e
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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