Skip to content

Commit 22b8559

Browse files
authored
Merge pull request #46 from microsoft/users/fbonacci/update-docs-winarena-base
Update docs for winarena-base changes
2 parents 71339a4 + be66412 commit 22b8559

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,25 +68,36 @@ Create a new `config.json` at the root of the project with the necessary keys (f
6868
}
6969
```
7070

71-
### 2. Prepare the Windows Arena Docker image
71+
### 2. Prepare the Windows Arena Docker Image
7272

73-
To use the default docker image from Docker Hub:
73+
#### 2.1 Pull the WinArena-Base Image from Docker Hub
74+
75+
To get started, pull the base image from Docker Hub:
7476

7577
```bash
76-
docker pull windowsarena/winarena:latest
78+
docker pull windowsarena/winarena-base:latest
7779
```
7880

79-
#### (Optional) 2.1 Build the Windows Arena Docker image locally:
81+
This image includes all the necessary dependencies (such as packages and models) required to run the code in the `src` directory.
82+
83+
#### 2.2 Build the WinArena Image Locally
84+
85+
Next, build the WinArena image locally:
8086

81-
To build your own image from scratch (optional):
8287
```bash
8388
cd scripts
8489
./build-container-image.sh
85-
# For docker image build options:
86-
./build-container-image.sh --help
90+
91+
# If there are any changes in 'Dockerfile-WinArena-Base', use the --build-base-image flag to build also the base image locally
92+
# ./build-container-image.sh --build-base-image true
93+
94+
# For other build options:
95+
# ./build-container-image.sh --help
8796
```
8897

89-
### 3. Prepare the Windows 11 image
98+
This will create the `windowsarena/winarena:latest` image with the latest code from the `src` directory.
99+
100+
### 3. Prepare the Windows 11 VM
90101

91102
<div align="center">
92103
<video src="https://github.com/user-attachments/assets/6d55b9b5-3242-49af-be20-64f2086108b9" height="500" alt="local_prepare_golden_image">

0 commit comments

Comments
 (0)