Skip to content

Commit 033762f

Browse files
committed
docs - in README.md, add the note to rename .env.example to .env for simple-app
1 parent c1635fa commit 033762f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,11 @@ That said, the way core library is written you can easily replace any component
149149
your own implementation i.e. your choice of LLM, embedding models etc. Even some of
150150
the classes as long as they implement the required interface.
151151

152+
**Note**:
153+
154+
Make sure to rename `.env.example` with `.env` if you are using OpenAI or AzureOpenAI
155+
and fill in the necessary environment variables.
156+
152157
```bash
153158
# To generate the index
154159
# default set azure_openai/gpt4-o/text-embedding-3-small

examples/simple-app/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Normally `rye sync` at the root of the repo will install all the dependenceis
1010

1111
## Run
1212

13+
**Note**:
14+
15+
Make sure to rename `.env.example` with `.env` if you are using OpenAI or AzureOpenAI
16+
and fill in the necessary environment variables.
17+
1318
```bash
1419
# assuming you are at the root of the repo
1520
python examples/simple-app/app/main.py --help

0 commit comments

Comments
 (0)