From e254a35ec98cafef0ffd9f2abf28a06faea5f6ce Mon Sep 17 00:00:00 2001 From: Alex Bailo Date: Thu, 27 Jun 2024 21:25:13 +0200 Subject: [PATCH] Imrpove documentation --- README.md | 6 +++--- docs/Windows.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c6a9dc98..916a31e6 100755 --- a/README.md +++ b/README.md @@ -24,13 +24,13 @@ There are several ways to get the environment ready. Choose any of them: docker pull bailool/mc-calib-dev # development environment ``` - - Run pulled image: + - Run pulled image (set `PATH_TO_REPO_ROOT` and `PATH_TO_DATA` appropriately): ```bash docker run \ -ti --rm \ - --volume="${PWD}:/home/MC-Calib" \ - --volume="PATH_TO_DATA:/home/MC-Calib/data" \ + --volume="$PATH_TO_REPO_ROOT:/home/MC-Calib" \ + --volume="$PATH_TO_DATA:/home/MC-Calib/data" \ bailool/mc-calib-prod ``` diff --git a/docs/Windows.md b/docs/Windows.md index c74df601..c62fe8c3 100644 --- a/docs/Windows.md +++ b/docs/Windows.md @@ -33,14 +33,14 @@ docker pull bailool/mc-calib-dev # development environment ``` 4. **Running Pulled Image using Docker** -In order to avoid running the image manually every time, we can create a `*.ps1` file containing the necessary docker run commands (or enter the commands manually in Windows Powershell or CMD). Below are the commands necessary. +In order to avoid running the image manually every time, we can create a `*.ps1` file containing the necessary docker run commands (or enter the commands manually in Windows Powershell or CMD). Below are the commands necessary. Set `PATH_TO_REPO_ROOT` and `PATH_TO_DATA` appropriately. ```bash Docker run ` -ti --rm ` - --volume=”$(PWD):/home/MC-Calib” ` - --volume=”PATH_TO_DATA:/home/MC-Calib/data” ` + --volume=”$PATH_TO_REPO_ROOT:/home/MC-Calib” ` + --volume=”$PATH_TO_DATA:/home/MC-Calib/data” ` bailool/mc-calib-prod ```