update documentation

This commit is contained in:
sean1832 2023-02-10 04:41:42 +11:00
parent d0d388f460
commit 6ac095831d

View File

@ -1,21 +1,12 @@
# Auto Setup
# Setup
### What you need
- Install python `3.11`
- OpenAI API keys
- Install [python 3.11](https://www.python.org/downloads)
- OpenAI [API keys](https://platform.openai.com/account/api-keys)
### .bat file
### Set up the project for the first time
1. Run `setup.bat`
2. Enter OpenAI API Key
# Manual Setup
### Python
1. Make sure to install python `3.11`
1. Create venv using `python -m venv venv` under root project root directory
2. Enter venv using `venv\Scripts\activate`
3. Update pip by using `python -m pip install --upgrade pip`
4. Installing required libraries using `pip3 install -r requirement.txt`
### API Key file
1. Create API Key file using cmd with command `if not exist .user\ (md .user\) & echo [YOUR API KEYS]> .user\API-KEYS.txt`
2. Enter your OpenAI API Key
# How to use
### Run
- Execute `run-webUI.bat`