From 9cf40d83fd93a02ec08646a825bfa3fc8a2b8063 Mon Sep 17 00:00:00 2001 From: Martin C <78377730+martincarapia@users.noreply.github.com> Date: Sun, 7 Apr 2024 21:16:20 -0400 Subject: [PATCH] Update README.md to include Docker. (#153) Co-authored-by: Kerem Yilmaz --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58877ce1..50e260c3 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,8 @@ Before you begin, make sure you have the following installed: - [Brew (if you're on a Mac)](https://brew.sh/) - [Poetry](https://python-poetry.org/docs/#installation) - `brew install poetry` - +- [Docker](https://docs.docker.com/engine/install/) + Note: Our setup script does these two for you, but they are here for reference. - [Python 3.11](https://www.python.org/downloads/) - `poetry env use 3.11` @@ -87,6 +88,7 @@ Note: Our setup script does these two for you, but they are here for reference. ## Setup 1. Clone the repository and navigate to the root directory +1. Open Docker Desktop (Works for Windows, macOS, and Linux) or run Docker Daemon 1. Run the setup script to install the necessary dependencies and setup your environment ```bash ./setup.sh