Imrpove documentation (#76)

rameau-fr · Jun 28, 2024 · ef63759 · ef63759
1 parent b213379
commit ef63759
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git 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
@@ -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
 ```