lazychih114
commited on
Commit
·
e577e3f
1
Parent(s):
c88a8d4
Update README.md
Browse files
README.md
CHANGED
|
@@ -41,21 +41,25 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
|
|
| 41 |
</div>
|
| 42 |
|
| 43 |
<!-- # Key Features -->
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
# 🔥 News
|
| 46 |
|
| 47 |
- **[2025.03.07]**: We open-source the codebase of 🦉 OWL project.
|
| 48 |
|
| 49 |
-
|
| 50 |
|
| 51 |
-
|
| 52 |
|
| 53 |
```bash
|
| 54 |
git clone https://github.com/camel-ai/owl.git
|
| 55 |
cd owl
|
| 56 |
```
|
| 57 |
|
| 58 |
-
|
| 59 |
|
| 60 |
Using Conda (recommended):
|
| 61 |
```bash
|
|
@@ -72,20 +76,20 @@ owl_env\Scripts\activate
|
|
| 72 |
source owl_env/bin/activate
|
| 73 |
```
|
| 74 |
|
| 75 |
-
|
| 76 |
|
| 77 |
```bash
|
| 78 |
python -m pip install -r requirements.txt
|
| 79 |
```
|
| 80 |
|
| 81 |
-
|
| 82 |
|
| 83 |
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:
|
| 84 |
|
| 85 |
1. *Copy and Rename*: Duplicate the `.env_example` file and rename the copy to `.env`.
|
| 86 |
2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields.
|
| 87 |
|
| 88 |
-
|
| 89 |
|
| 90 |
Run the following minimal example:
|
| 91 |
|
|
|
|
| 41 |
</div>
|
| 42 |
|
| 43 |
<!-- # Key Features -->
|
| 44 |
+
<!-- # 📋 Table of Contents -->
|
| 45 |
+
|
| 46 |
+
|
| 47 |
+
|
| 48 |
|
| 49 |
# 🔥 News
|
| 50 |
|
| 51 |
- **[2025.03.07]**: We open-source the codebase of 🦉 OWL project.
|
| 52 |
|
| 53 |
+
# 🛠️ Installation
|
| 54 |
|
| 55 |
+
## **Clone the Github repository**
|
| 56 |
|
| 57 |
```bash
|
| 58 |
git clone https://github.com/camel-ai/owl.git
|
| 59 |
cd owl
|
| 60 |
```
|
| 61 |
|
| 62 |
+
## **Set up Environment**
|
| 63 |
|
| 64 |
Using Conda (recommended):
|
| 65 |
```bash
|
|
|
|
| 76 |
source owl_env/bin/activate
|
| 77 |
```
|
| 78 |
|
| 79 |
+
## **Install Dependencies**
|
| 80 |
|
| 81 |
```bash
|
| 82 |
python -m pip install -r requirements.txt
|
| 83 |
```
|
| 84 |
|
| 85 |
+
## **Setup Environment Variables**
|
| 86 |
|
| 87 |
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:
|
| 88 |
|
| 89 |
1. *Copy and Rename*: Duplicate the `.env_example` file and rename the copy to `.env`.
|
| 90 |
2. *Fill in Your Keys*: Open the `.env` file and insert your API keys in the corresponding fields.
|
| 91 |
|
| 92 |
+
# 🚀 Quick Start
|
| 93 |
|
| 94 |
Run the following minimal example:
|
| 95 |
|