From 954a78be363326e23a1ff0840609258ff9db6785 Mon Sep 17 00:00:00 2001
From: FredWuCZ <fredwucz@outlook.com>
Date: Tue, 22 Oct 2024 22:37:46 +0800
Subject: [PATCH] Update Docker guidelines

---
 .../providers/docker/DOCKER_GUIDELINE.md      | 29 +++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 desktop_env/providers/docker/DOCKER_GUIDELINE.md

diff --git a/desktop_env/providers/docker/DOCKER_GUIDELINE.md b/desktop_env/providers/docker/DOCKER_GUIDELINE.md
new file mode 100644
index 0000000..eb0cbde
--- /dev/null
+++ b/desktop_env/providers/docker/DOCKER_GUIDELINE.md
@@ -0,0 +1,29 @@
+# Configuration of Docker
+
+---
+
+Welcome to the Docker VM Management documentation.
+
+## Prerequisite: Check if your machine supports KVM
+
+We recommend running the VM with KVM support. To check if your hosting platform supports KVM, run
+
+```
+egrep -c '(vmx|svm)' /proc/cpuinfo
+```
+
+on Linux. If the return value is greater than zero, the processor should be able to support KVM.
+
+> **Note**: macOS hosts generally do not support KVM.
+
+## Install Docker
+
+If your hosting platform supports graphical user interface (GUI), you may refer to [Install Docker Desktop on Linux](https://docs.docker.com/desktop/install/linux/) or [Install Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) based on your OS.  Otherwise, you may [Install Docker Engine](https://docs.docker.com/engine/install/).
+
+## Running Experiments
+
+Add the following arguments when initializing `DesktopEnv`: 
+- `provider`: `docker`
+- `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM
+
+Please allow for some time to download the virtual machine snapshot on your first run.