lazychih114 commited on
Commit
672cb5e
·
1 Parent(s): f87fb65

update readme

Browse files
Files changed (2) hide show
  1. README.md +12 -2
  2. README_zh.md +8 -2
README.md CHANGED
@@ -129,7 +129,10 @@ playwright install
129
  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:
130
 
131
  1. *Copy and Rename*: Duplicate the `.env_example` file and rename the copy to `.env`.
132
- 2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields.
 
 
 
133
  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
134
 
135
 
@@ -137,11 +140,18 @@ In the `owl/.env_example` file, you will find all the necessary API keys along w
137
 
138
  # 🚀 Quick Start
139
 
140
- Run the following minimal example:
141
 
142
  ```bash
143
  python owl/run.py
144
  ```
 
 
 
 
 
 
 
145
  You can run OWL agent with your own task by modifying the `run.py` script:
146
 
147
  ```python
 
129
  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:
130
 
131
  1. *Copy and Rename*: Duplicate the `.env_example` file and rename the copy to `.env`.
132
+ ```bash
133
+ cp owl/.env_template .env
134
+ ```
135
+ 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).)
136
  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
 
138
 
 
140
 
141
  # 🚀 Quick Start
142
 
143
+ Run the following demo case:
144
 
145
  ```bash
146
  python owl/run.py
147
  ```
148
+
149
+ For a simpler version that only requires an LLM API key, you can try our minimal example:
150
+
151
+ ```bash
152
+ python owl/run_mini.py
153
+ ```
154
+
155
  You can run OWL agent with your own task by modifying the `run.py` script:
156
 
157
  ```python
README_zh.md CHANGED
@@ -133,13 +133,19 @@ python -m pip install -r requirements.txt
133
 
134
  # 🚀 快速开始
135
 
136
- 运行以下最小示例:
137
 
138
  ```bash
139
  python owl/run.py
140
  ```
141
 
142
- 你可以通过修改 `run.py` 来运行自定义任务的 OWL 智能体:
 
 
 
 
 
 
143
 
144
  ```python
145
  # Define your own task
 
133
 
134
  # 🚀 快速开始
135
 
136
+ 运行以下示例:
137
 
138
  ```bash
139
  python owl/run.py
140
  ```
141
 
142
+ 我们还提供了一个最小化示例,只需配置LLM的API密钥即可运行:
143
+
144
+ ```bash
145
+ python owl/run_mini.py
146
+ ```
147
+
148
+ 你可以通过修改 `run.py` 脚本来运行自己的任务:
149
 
150
  ```python
151
  # Define your own task