From a463787eef7835055b6ce260b0afcdcdb3ae5689 Mon Sep 17 00:00:00 2001 From: Sai Emani Date: Thu, 5 Mar 2026 22:59:13 +0530 Subject: [PATCH] docs: update README to specify correct Docker Compose file (fixes #32) --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 682773d..a2dbc34 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,14 @@ cd veren We assume you have already gone through the required configuration and added the necessary files as described in [@essentials](https://github.com/atithi4dev/veren/blob/main/Docs/GITHUB_SETUP.md) before starting the project. + **Start the services using Docker Compose:** ```bash -docker compose up --build +docker compose -f docker-compose.dev.yml up --build ``` -Now you are ready to visit [api-guidelines](https://github.com/atithi4dev/veren/blob/main/Docs/API_DOCUMENTATION.md) to access the differnt routes and supported features. +> **Note:** The default command `docker compose up --build` will fail because there is no root-level `docker-compose.yml`. Make sure to specify the correct file as above. + +Now you are ready to visit [api-guidelines](https://github.com/atithi4dev/veren/blob/main/Docs/API_DOCUMENTATION.md) to access the different routes and supported features. ## Architecture Overview -