Skip to content

Commit 093706f

Browse files
update README options
1 parent 353be7d commit 093706f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@ We built this API to show how the technology can fight this and other crises, an
1515
To classify your own images, you can use the live API: use the link [here](https://fire-detection-api.herokuapp.com/docs) to read the documentation and send requests.
1616

1717
### Running Locally
18+
You only need to use ONE of the following options:
1819

19-
#### Using Docker
20+
#### Option #1: Using Docker
2021
You can download this repository and run it using [Docker](https://www.docker.com/get-started):
2122

2223
```docker compose up```
2324

24-
#### Using Virtual Environments
25+
#### Option #2: Using Virtual Environments
2526

26-
Alternatively, you can also make a virtual environment and install the dependencies locally:
27+
Alternatively, you can also make a virtual environment. This is *recommended*, as it will allow you to also run the automated tests as well
28+
(discussed below). Here is the command to install the dependencies locally:
2729

2830
```
2931
$ python3 -m venv env

0 commit comments

Comments
 (0)