From ca85a02e4be896a7b3471303cc3651c406f7d901 Mon Sep 17 00:00:00 2001 From: Tianbao Xie <47296835+Timothyxxx@users.noreply.github.com> Date: Tue, 2 Apr 2024 19:57:41 +0800 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 53f98ac..8bf660f 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,24 @@ Paper

+[![OSWorld](https://os-world.github.io/static/videos/main.mp4)](https://os-world.github.io/static/videos/main.mp4) + ![Overview]() ## Updates - 2024-03-28: We released our [paper](), [environment and benchmark](), and [project page](https://os-world.github.io/). Check it out! ## Install -1. Install VMWare and configure `vmrun` command, and verify by: +### Non-virtualized platform +Suppose you are on a system that has not yet been virtualized, meaning you are not on an AWS, Azure, or k8s virtualized environment. +Otherwise, refer to the [virtualized platform](https://github.com/xlang-ai/OSWorld?tab=readme-ov-file##virtualized-platform) part. +1. Install [VMware Work Station Pro](https://www.vmware.com/products/workstation-pro/workstation-pro-evaluation.html) (for Apple Chips, it should be [VMware Fusion](https://www.vmware.com/go/getfusion)) and configure `vmrun` command, and verify successful installation by: ```bash vmrun -T ws list ``` +If the installation along with the environment variable set are successful, you will see the message showing the current running virtual machines. -2. Install the environment package, download the examples and the virtual machine image. +2. Install the environment package, and download the examples and the virtual machine image. For x86_64 CPU Linux or Windows, you can install the environment package and download the examples and the virtual machine image by running the following commands: Remove the `nogui` parameter if you want to see what happens in the virtual machine. ```bash @@ -35,6 +41,9 @@ vmrun -T fusion start "Ubuntu/Ubuntu.vmx" vmrun -T fusion snapshot "Ubuntu/Ubuntu.vmx" "init_state" ``` +### Virtualized platform +We are working on supporting it👷, hold tight! + ## Quick Start Run the following minimal example to interact with the environment: ```python