From c47e9759a1782cc10dbe54990fa8c97d069ea4ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aaron=20D=C3=B6tsch?= <aaron@fsmpi.rwth-aachen.de> Date: Thu, 3 Aug 2023 13:15:20 +0200 Subject: [PATCH] Update Building section in README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e70870..6bbf3ca 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,19 @@ ## Building +First, rename the `.env.example` file to `.env` and the `docker-compose.yml.example` to `docker-compose.yml`. Then fill in the values in the `.env` file. The `docker-compose.yml` file should be fine as it is, but you can change the ports and volume locations if you want to. + To build the app, compile the docker container. ```bash docker compose build ``` -To start it you then just have to set up the `docker-compose.yml` and environment variables and use `docker compose up`. +Afterwards you can start the app. + +```bash +docker compose up +``` ## Setup -- GitLab