From 7912c277216b6e9a1675987fbd8b5b3aea99e007 Mon Sep 17 00:00:00 2001 From: Tianbao Xie <47296835+Timothyxxx@users.noreply.github.com> Date: Tue, 2 Apr 2024 22:03:11 +0800 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09613bd..9bc34be 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,31 @@ ### Non-virtualized platform Suppose you are operating on a system that has not been virtualized, meaning you are not utilizing a virtualized environment like AWS, Azure, or k8s. If this is the case, proceed with the instructions below. However, if you are on a virtualized platform, please refer to the [virtualized platform](https://github.com/xlang-ai/OSWorld?tab=readme-ov-file#virtualized-platform) section. -1. Install [VMware Workstation Pro](https://www.vmware.com/products/workstation-pro/workstation-pro-evaluation.html) (for systems with Apple Chips, you should install [VMware Fusion](https://www.vmware.com/go/getfusion)) and configure the `vmrun` command. Verify the successful installation by running the following: +1. First, clone this repository and `cd` into it. Then, install the dependencies listed in `requirements.txt`. It is recommended that you use the latest version of Conda to manage the environment, but you can also choose to manually install the dependencies. Please ensure that the version of Python is >= 3.9. +```bash +# Clone the OSWorld repository +git clone https://github.com/xlang-ai/OSWorld + +# Change directory into the cloned repository +cd OSWorld + +# Optional: Create a Conda environment for OSWorld +# conda create -n osworld python=3.9 +# conda activate osworld + +# Install required dependencies +pip install -r requirements.txt +``` + +2. Install [VMware Workstation Pro](https://www.vmware.com/products/workstation-pro/workstation-pro-evaluation.html) (for systems with Apple Chips, you should install [VMware Fusion](https://www.vmware.com/go/getfusion)) and configure the `vmrun` command. Verify the successful installation by running the following: ```bash vmrun -T ws list ``` If the installation along with the environment variable set is successful, you will see the message showing the current running virtual machines. -2. Install the environment package, download the examples, and obtain the virtual machine image. If you are using Linux or Windows with an x86_64 CPU, install the environment package and download the examples and the virtual machine image by executing the following commands: +3. Obtain the virtual machine image. If you are using Linux or Windows with an x86_64 CPU, install the environment package and download the examples and the virtual machine image by executing the following commands: Remove the `nogui` parameter if you wish to view the activities within the virtual machine. ```bash -git clone https://github.com/xlang-ai/OSWorld -cd OSWorld -pip install -r requirements.txt gdown https://drive.google.com/drive/folders/1HX5gcf7UeyR-2UmiA15Q9U-Wr6E6Gio8 -O Ubuntu --folder vmrun -T ws start "Ubuntu/Ubuntu.vmx" nogui vmrun -T ws snapshot "Ubuntu/Ubuntu.vmx" "init_state"