Skip to content

Commit 74fac6a

Browse files
authored
Update README.md
Update README.md
2 parents 8cf1f9a + 68e4a02 commit 74fac6a

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,7 @@ The sample project does the following procedures to achieve the above output:
128128

129129
## How to run the project
130130

131-
Example only supports Unix-like systems (such as Linux, macOS, BSD). If you are a Windows user, we highly recommend leveraging Windows Subsystem for Linux (WSL) or Dockerize the app to run as a container.
132-
133-
### Run with Docker
134-
135-
1. [Set environment variables](#step-2-set-environment-variables)
136-
2. From the project root folder, open your terminal and run `docker compose up`.
137-
3. Navigate to `localhost:8501` on your browser when docker installion is successful.
131+
Example only supports Unix-like systems (such as Linux, macOS, BSD). If you are a Windows user, we highly recommend leveraging Windows Subsystem for Linux (WSL) or [Dockerize the app](#run-with-docker) to run as a container.
138132

139133
### Prerequisites
140134

@@ -181,24 +175,26 @@ RAINFOREST_BASE_URL={RAINFOREST_BASE_URL}
181175
RAINFOREST_API_KEY={RAINFOREST_API_KEY}
182176
```
183177

184-
### Step 3: Install the app dependencies
178+
### Step 3 (Optional): Create a new virtual environment
185179

186-
Install the required packages:
180+
Create a new virtual environment in the same folder and activate that environment:
187181

188182
```bash
189-
pip install --upgrade -r requirements.txt
183+
python -m venv pw-env && source pw-env/bin/activate
190184
```
191-
### Step 4 (Optional): Create a new virtual environment
192185

193-
Create a new virtual environment in the same folder and activate that environment:
186+
### Step 4: Install the app dependencies
187+
188+
Install the required packages:
194189

195190
```bash
196-
python -m venv pw-env && source pw-env/bin/activate
191+
pip install --upgrade -r requirements.txt
197192
```
198193

194+
199195
### Step 5: Run and start to use it
200196

201-
You start the application by navigating to `llm_app` folder and running `main.py`:
197+
Start the application by running `main.py`:
202198

203199
```bash
204200
python main.py
@@ -249,3 +245,9 @@ Discounted Price: $117.60
249245
Discount Percentage: 10%
250246
Ship Date: 2024-08-09
251247
```
248+
249+
### Run with Docker (for Windows users)
250+
251+
1. [Set environment variables](#step-2-set-environment-variables)
252+
2. From the project root folder, open your terminal and run `docker compose up`.
253+
3. Navigate to `localhost:8501` on your browser when docker installion is successful.

0 commit comments

Comments
 (0)