diff --git a/README.md b/README.md index 5ef257e..eaf87a1 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,10 @@ playwright install In the `owl/.env_example` file, you will find all the necessary API keys along with the websites where you can register for each service. To use these API services, follow these steps: 1. *Copy and Rename*: Duplicate the `.env_example` file and rename the copy to `.env`. -2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields. +```bash +cp owl/.env_template .env +``` +2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields. (For the minimal example (`run_mini.py`), you only need to configure the LLM API key (e.g., OPENAI_API_KEY).) 3. *For using more other models*: please refer to our CAMEL models docs:https://docs.camel-ai.org/key_modules/models.html#supported-model-platforms-in-camel @@ -137,11 +140,18 @@ In the `owl/.env_example` file, you will find all the necessary API keys along w # 🚀 Quick Start -Run the following minimal example: +Run the following demo case: ```bash python owl/run.py ``` + +For a simpler version that only requires an LLM API key, you can try our minimal example: + +```bash +python owl/run_mini.py +``` + You can run OWL agent with your own task by modifying the `run.py` script: ```python diff --git a/README_zh.md b/README_zh.md index 76dffae..cbb5ff2 100644 --- a/README_zh.md +++ b/README_zh.md @@ -133,13 +133,19 @@ python -m pip install -r requirements.txt # 🚀 快速开始 -运行以下最小示例: +运行以下示例: ```bash python owl/run.py ``` -你可以通过修改 `run.py` 来运行自定义任务的 OWL 智能体: +我们还提供了一个最小化示例,只需配置LLM的API密钥即可运行: + +```bash +python owl/run_mini.py +``` + +你可以通过修改 `run.py` 脚本来运行自己的任务: ```python # Define your own task