Skip to content

Commit 5e6429e

Browse files
husseinmozannarstefanoamorelli
authored andcommitted
Update README.md for docker running instructions (microsoft#224)
1 parent c4dfd8f commit 5e6429e

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,13 @@ If you're interested in reading more checkout our [blog post](https://www.micros
144144

145145
### 📝 Pre-Requisites
146146

147-
1. If running on **Windows** or **Mac** you must use [Docker Desktop](https://www.docker.com/products/docker-desktop/). If running on **Linux**, you should use [Docker Engine](https://docs.docker.com/engine/install/). **Magentic-UI was not tested with other container providers.**
147+
**Note**: If you're using Windows, we highly recommend using [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) (Windows Subsystem for Linux).
148148

149-
2. If using Docker Desktop, make sure it is set up to use WSL2:
150-
- Go to Settings > Resources > WSL Integration
151-
- Enable integration with your development distro You can find more detailed instructions about this step [here](https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers).
149+
1. If running on **Windows** or **Mac** you should use [Docker Desktop](https://www.docker.com/products/docker-desktop/) or if inside WSL2 you can install Docker directly inside WSL [docker in WSL2 guide](https://gist.github.com/dehsilvadeveloper/c3bdf0f4cdcc5c177e2fe9be671820c7). If running on **Linux**, you should use [Docker Engine](https://docs.docker.com/engine/install/).
150+
151+
If using Docker Desktop, make sure it is set up to use WSL2:
152+
- Go to Settings > Resources > WSL Integration
153+
- Enable integration with your development distro You can find more detailed instructions about this step [here](https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers).
152154

153155

154156

@@ -157,7 +159,7 @@ If you're interested in reading more checkout our [blog post](https://www.micros
157159
3. You need at least [Python 3.10](https://www.python.org/downloads/) installed.
158160

159161

160-
If you are on Windows, you **must** run Magentic-UI inside [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) (Windows Subsystem for Linux) for correct Docker and file path compatibility. The steps below assume you are using VS Code.
162+
If you are on Windows, we recommend to run Magentic-UI inside [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) (Windows Subsystem for Linux) for correct Docker and file path compatibility.
161163

162164

163165

@@ -418,4 +420,4 @@ Any use of third-party trademarks or logos are subject to those third-party's po
418420

419421
Privacy information can be found at <https://go.microsoft.com/fwlink/?LinkId=521839>
420422

421-
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel, or otherwise.
423+
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel, or otherwise.

0 commit comments

Comments
 (0)