mirror of
https://github.com/camel-ai/owl.git
synced 2026-03-22 05:57:17 +08:00
update readme for more install optionals
This commit is contained in:
50
README.md
50
README.md
@@ -104,6 +104,8 @@ https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-13
|
||||
|
||||
# 🛠️ Installation
|
||||
|
||||
## Option 1: Using uv (Recommended)
|
||||
|
||||
```bash
|
||||
# Clone github repo
|
||||
git clone https://github.com/camel-ai/owl.git
|
||||
@@ -131,6 +133,54 @@ uv pip install -e .
|
||||
deactivate
|
||||
```
|
||||
|
||||
## Option 2: Using venv and pip
|
||||
|
||||
```bash
|
||||
# Clone github repo
|
||||
git clone https://github.com/camel-ai/owl.git
|
||||
|
||||
# Change directory into project directory
|
||||
cd owl
|
||||
|
||||
# Create a virtual environment
|
||||
# For Python 3.10 (also works with 3.11, 3.12)
|
||||
python3.10 -m venv .venv
|
||||
|
||||
# Activate the virtual environment
|
||||
# For macOS/Linux
|
||||
source .venv/bin/activate
|
||||
# For Windows
|
||||
.venv\Scripts\activate
|
||||
|
||||
# Install from requirements.txt
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Option 3: Using conda
|
||||
|
||||
```bash
|
||||
# Clone github repo
|
||||
git clone https://github.com/camel-ai/owl.git
|
||||
|
||||
# Change directory into project directory
|
||||
cd owl
|
||||
|
||||
# Create a conda environment
|
||||
conda create -n owl python=3.10
|
||||
|
||||
# Activate the conda environment
|
||||
conda activate owl
|
||||
|
||||
# Option 1: Install as a package (recommended)
|
||||
pip install -e .
|
||||
|
||||
# Option 2: Install from requirements.txt
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Exit the conda environment when done
|
||||
conda deactivate
|
||||
```
|
||||
|
||||
## **Setup Environment Variables**
|
||||
|
||||
In the `owl/.env_template` 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:
|
||||
|
||||
56
README_zh.md
56
README_zh.md
@@ -67,9 +67,9 @@
|
||||
- [🎬 演示视频](#-演示视频)
|
||||
- [✨️ 核心功能](#-核心功能)
|
||||
- [🛠️ 安装](#️-安装)
|
||||
- [**克隆 Github 仓库**](#克隆-github-仓库)
|
||||
- [**设置环境**](#设置环境)
|
||||
- [**安装依赖**](#安装依赖)
|
||||
- [**选项1:使用 uv(推荐)**](#选项1使用-uv推荐)
|
||||
- [**选项2:使用 venv 和 pip**](#选项2使用-venv-和-pip)
|
||||
- [**选项3:使用 conda**](#选项3使用-conda)
|
||||
- [**设置环境变量**](#设置环境变量)
|
||||
- [**使用Docker运行**](#使用docker运行)
|
||||
- [🚀 快速开始](#-快速开始)
|
||||
@@ -103,7 +103,7 @@ https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-13
|
||||
|
||||
# 🛠️ 安装
|
||||
|
||||
## **克隆 Github 仓库**
|
||||
## 选项1:使用 uv(推荐)
|
||||
|
||||
```bash
|
||||
# 克隆 GitHub 仓库
|
||||
@@ -132,6 +132,54 @@ uv pip install -e .
|
||||
deactivate
|
||||
```
|
||||
|
||||
## 选项2:使用 venv 和 pip
|
||||
|
||||
```bash
|
||||
# 克隆 GitHub 仓库
|
||||
git clone https://github.com/camel-ai/owl.git
|
||||
|
||||
# 进入项目目录
|
||||
cd owl
|
||||
|
||||
# 创建虚拟环境
|
||||
# 对于 Python 3.10(也适用于 3.11、3.12)
|
||||
python3.10 -m venv .venv
|
||||
|
||||
# 激活虚拟环境
|
||||
# 对于 macOS/Linux
|
||||
source .venv/bin/activate
|
||||
# 对于 Windows
|
||||
.venv\Scripts\activate
|
||||
|
||||
# 从 requirements.txt 安装
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## 选项3:使用 conda
|
||||
|
||||
```bash
|
||||
# 克隆 GitHub 仓库
|
||||
git clone https://github.com/camel-ai/owl.git
|
||||
|
||||
# 进入项目目录
|
||||
cd owl
|
||||
|
||||
# 创建 conda 环境
|
||||
conda create -n owl python=3.10
|
||||
|
||||
# 激活 conda 环境
|
||||
conda activate owl
|
||||
|
||||
# 选项1:作为包安装(推荐)
|
||||
pip install -e .
|
||||
|
||||
# 选项2:从 requirements.txt 安装
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 完成后退出 conda 环境
|
||||
conda deactivate
|
||||
```
|
||||
|
||||
## **设置环境变量**
|
||||
|
||||
在 `owl/.env_template` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作:
|
||||
|
||||
4
requirements.txt
Normal file
4
requirements.txt
Normal file
@@ -0,0 +1,4 @@
|
||||
camel-ai[all]==0.2.23
|
||||
chunkr-ai>=0.0.41
|
||||
docx2markdown>=0.1.1
|
||||
gradio>=3.50.2
|
||||
Reference in New Issue
Block a user