Skip to content

Commit 8e2ee20

Browse files
committed
update readme
1 parent f157621 commit 8e2ee20

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,29 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
6666
- [🎬 Demo Video](#-demo-video)
6767
- [✨️ Core Features](#️-core-features)
6868
- [🛠️ Installation](#️-installation)
69+
- [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended)
70+
- [Option 2: Using venv and pip](#option-2-using-venv-and-pip)
71+
- [Option 3: Using conda](#option-3-using-conda)
72+
- [**Setup Environment Variables**](#setup-environment-variables)
73+
- [Option 1: Using a `.env` File (Recommended)](#option-1-using-a-env-file-recommended)
74+
- [Option 2: Setting Environment Variables Directly](#option-2-setting-environment-variables-directly)
75+
- [**Running with Docker**](#running-with-docker)
6976
- [🚀 Quick Start](#-quick-start)
77+
- [Basic Usage](#basic-usage)
78+
- [Running with Different Models](#running-with-different-models)
79+
- [Model Requirements](#model-requirements)
80+
- [Supported Models](#supported-models)
81+
- [Example Tasks](#example-tasks)
7082
- [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
7183
- [Model Context Protocol (MCP)](#model-context-protocol-mcp)
84+
- [Available Toolkits](#available-toolkits)
85+
- [Available Toolkits](#available-toolkits-1)
86+
- [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities)
87+
- [Text-Based Toolkits](#text-based-toolkits)
88+
- [Customizing Your Configuration](#customizing-your-configuration)
7289
- [🌐 Web Interface](#-web-interface)
90+
- [Starting the Web UI](#starting-the-web-ui)
91+
- [Features](#features)
7392
- [🧪 Experiments](#-experiments)
7493
- [⏱️ Future Plans](#️-future-plans)
7594
- [📄 License](#-license)
@@ -78,6 +97,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
7897
- [🔥 Community](#-community)
7998
- [❓ FAQ](#-faq)
8099
- [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
100+
- [Accessing CAMEL Source Code](#accessing-camel-source-code)
81101
- [⭐ Star History](#-star-history)
82102

83103
# 🔥 News
@@ -270,11 +290,20 @@ cp owl/.env_template owl/.env
270290
# Edit the .env file and fill in your API keys
271291

272292
# Option 1: Using docker-compose directly
273-
# (By default it's using pre-built online image, you can also check the docker-compose.yml for building locally)
274-
cd .container
275-
293+
# Docker image options:
294+
# Option 1: Use pre-built image from Docker Hub (default, faster)
295+
# This option downloads a ready-to-use image and is recommended for most users
276296
docker-compose up -d
277297

298+
# Option 2: Build image locally (more customizable)
299+
# If you need to customize the Docker image or are unable to access Docker Hub:
300+
# 1. Open docker-compose.yml
301+
# 2. Comment out the "image: mugglejinx/owl:latest" line
302+
# 3. Uncomment the "build:" section and its nested properties
303+
# 4. Then run:
304+
docker-compose up -d --build
305+
cd .container
306+
278307
# Run OWL inside the container
279308
docker-compose exec owl bash
280309

@@ -286,7 +315,7 @@ playwright install-deps
286315
#run example demo script
287316
xvfb-python examples/run.py
288317

289-
# Option 2: Build and run using the provided scripts
318+
# Option 3: Build and run using the provided scripts
290319
cd .container
291320
chmod +x build_docker.sh
292321
./build_docker.sh

0 commit comments

Comments
 (0)