diff --git a/README.md b/README.md index 1eb994c8c..b3b69f949 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,81 @@ -# MetaGPT: The Multi-Role Meta Programming Framework +# MetaGPT:多角色元编程框架
-Enable GPT to work in software company, collaborating to tackle more complex tasks. +使 GPT 以软件公司的形式工作,协作处理更复杂的任务
-1. The team can handle **Boss's one line Requirement** cooperate and generate **user stories / competetive analysis / requirements / data structures / apis / files etc.** -2. The team consists of **product manager / architect / project manager / engineer**, it provides the full process of a **software company.** +1. 该团队可以消化**一句话的老板需求**合作并生成**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等** +2. 该团队包括**产品经理 / 架构师 / 项目经理 / 工程师**,它提供了一个**软件公司**的全过程 - + -## Examples (fully generated by GPT-4) +## 示例(均由 GPT-4 生成) -For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is data & api design +例如,键入`python startup.py "写个类似今日头条的推荐系统"`并回车,你会获得一系列输出,其一是数据结构与API设计 - + -It requires around **$0.2** (GPT-4 api's costs) to generate one example with analysis and design, around **$2.0** to a full project. +这需要大约**0.2美元**(GPT-4 API的费用)来生成一个带有分析和设计的示例,大约2.0美元用于一个完整的项目 -## Installation +## 安装 ```bash -# Step 1: Ensure that NPM is installed on your system. Then install mermaid-js. +# 第 1 步:确保您的系统上安装了 NPM。并使用npm安装mermaid-js npm --version sudo npm install -g @mermaid-js/mermaid-cli -# Step 2: Ensure that Python 3.9+ is installed on your system. You can check this by using: +# 第 2 步:确保您的系统上安装了 Python 3.9+。您可以使用以下命令进行检查: python --version -# Step 3: Clone the repository to your local machine, and install it. +# 第 3 步:克隆仓库到您的本地机器,并进行安装。 git clone https://github.com/geekan/metagpt cd metagpt python setup.py install ``` -## Configuration +## 配置 -- Configure your `OPENAI_API_KEY` in any of `config/key.yaml / config/config.yaml / env` -- Priority order: `config/key.yaml > config/config.yaml > env` +- 在 `config/key.yaml / config/config.yaml / env` 中配置您的 `OPENAI_API_KEY` +- 优先级顺序:`config/key.yaml > config/config.yaml > env` ```bash -# Copy the configuration file and make the necessary modifications. +# 复制配置文件并进行必要的修改。 cp config/config.yaml config/key.yaml ``` -| Variable Name | config/key.yaml | env | +| 变量名 | config/key.yaml | env | |--------------------------------------------|-------------------------------------------|--------------------------------| -| OPENAI_API_KEY # Replace with your own key | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." | -| OPENAI_API_BASE # Optional | OPENAI_API_BASE: "https://
+
diff --git a/README_CN.md b/README_CN.md
deleted file mode 100644
index 688fbcdcf..000000000
--- a/README_CN.md
+++ /dev/null
@@ -1,105 +0,0 @@
-# MetaGPT:多角色元编程框架
-
-
-
--使 GPT 以软件公司的形式工作,协作处理更复杂的任务 -
- - - -1. 该团队可以消化**一句话的老板需求**合作并生成**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等** -2. 该团队包括**产品经理 / 架构师 / 项目经理 / 工程师**,它提供了一个**软件公司**的全过程 - - - -## 示例(均由 GPT-4 生成) - -例如,键入`python startup.py "写个类似今日头条的推荐系统"`并回车,你会获得一系列输出,其一是数据结构与API设计 - - - -这需要大约**0.2美元**(GPT-4 API的费用)来生成一个带有分析和设计的示例,大约2.0美元用于一个完整的项目 - -## 安装 - -```bash -# 第 1 步:确保您的系统上安装了 NPM。并使用npm安装mermaid-js -npm --version -sudo npm install -g @mermaid-js/mermaid-cli - -# 第 2 步:确保您的系统上安装了 Python 3.9+。您可以使用以下命令进行检查: -python --version - -# 第 3 步:克隆仓库到您的本地机器,并进行安装。 -git clone https://github.com/geekan/metagpt -cd metagpt -python setup.py install -``` - -## 配置 - -- 在 `config/key.yaml / config/config.yaml / env` 中配置您的 `OPENAI_API_KEY` -- 优先级顺序:`config/key.yaml > config/config.yaml > env` - -```bash -# 复制配置文件并进行必要的修改。 -cp config/config.yaml config/key.yaml -``` - -| 变量名 | config/key.yaml | env | -|--------------------------------------------|-------------------------------------------|--------------------------------| -| OPENAI_API_KEY # 用您自己的密钥替换 | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." | -| OPENAI_API_BASE # 可选 | OPENAI_API_BASE: "https://
-
diff --git a/README_EN.md b/README_EN.md
new file mode 100644
index 000000000..d4dc3eff9
--- /dev/null
+++ b/README_EN.md
@@ -0,0 +1,99 @@
+# MetaGPT: The Multi-Role Meta Programming Framework
+
+
+
++Enable GPT to work in software company, collaborating to tackle more complex tasks. +
+ + + +1. The team can handle **Boss's one line Requirement** cooperate and generate **user stories / competetive analysis / requirements / data structures / apis / files etc.** +2. The team consists of **product manager / architect / project manager / engineer**, it provides the full process of a **software company.** + + + +## Examples (fully generated by GPT-4) + +For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is data & api design + + + +It requires around **$0.2** (GPT-4 api's costs) to generate one example with analysis and design, around **$2.0** to a full project. + +## Installation + +```bash +# Step 1: Ensure that NPM is installed on your system. Then install mermaid-js. +npm --version +sudo npm install -g @mermaid-js/mermaid-cli + +# Step 2: Ensure that Python 3.9+ is installed on your system. You can check this by using: +python --version + +# Step 3: Clone the repository to your local machine, and install it. +git clone https://github.com/geekan/metagpt +cd metagpt +python setup.py install +``` + +## Configuration + +- Configure your `OPENAI_API_KEY` in any of `config/key.yaml / config/config.yaml / env` +- Priority order: `config/key.yaml > config/config.yaml > env` + +```bash +# Copy the configuration file and make the necessary modifications. +cp config/config.yaml config/key.yaml +``` + +| Variable Name | config/key.yaml | env | +|--------------------------------------------|-------------------------------------------|--------------------------------| +| OPENAI_API_KEY # Replace with your own key | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." | +| OPENAI_API_BASE # Optional | OPENAI_API_BASE: "https://