README and env example update

This commit is contained in:
bigvo
2023-10-24 10:33:18 +00:00
parent 9a7555871d
commit 3ecf30a357
4 changed files with 13 additions and 6 deletions

View File

@@ -68,8 +68,11 @@ After you have Python and (optionally) PostgreSQL installed, follow these steps:
5. `pip install -r requirements.txt` (install the dependencies)
6. `cd pilot`
7. `mv .env.example .env` (create the .env file)
8. Add your environment (OpenAI/Azure), your API key, and the SQLite/PostgreSQL database info to the `.env` file
- to change from SQLite to PostgreSQL in your .env, just set `DATABASE_TYPE=postgres`
8. Add your environment to the `.env` file:
- LLM Provider (OpenAI/Azure/Openrouter)
- your API key
- database settings: SQLite/PostgreSQL (to change from SQLite to PostgreSQL, just set `DATABASE_TYPE=postgres`)
- optionally set IGNORE_FOLDERS for the folders which shouldn't be tracked by GPT Pilot in workspace, useful to ignore folders created by compilers (i.e. `IGNORE_FOLDERS=folder1,folder2,folder3`)
9. `python db_init.py` (initialize the database)
10. `python main.py` (start GPT Pilot)