diff --git a/README.md b/README.md index 39aeb528a..001cb09b6 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,84 @@ -# MetaGPT：多智能体元编程框架 +# MetaGPT: The Multi-Agent Meta Programming Framework

-MetaGPT logo: 使 GPT 以软件公司的形式工作，协作处理更复杂的任务 +MetaGPT logo: Enable GPT to work in software company, collaborating to tackle more complex tasks.

-使 GPTs 组成软件公司，协作处理更复杂的任务 +Make GPTs form a software company to collaboratively handle more complex tasks.

-CN doc -EN doc +CN doc +EN doc Discord Follow License: MIT Twitter Follow

-1. MetaGPT输入**一句话的老板需求**，输出**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等** -2. MetaGPT内部包括**产品经理 / 架构师 / 项目经理 / 工程师**，它提供了一个**软件公司**的全过程与精心调配的SOP - 1. `Code = SOP(Team)` 是核心哲学。我们将SOP具象化，并且用于LLM构成的团队 +1. MetaGPT takes a **single sentence of a boss's requirement** as input and outputs **user stories / competitive analysis / requirements / data structures / APIs / documents, etc.** +2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire process of a **software company along with carefully orchestrated SOPs.** + 1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs. -![一个完全由大语言模型角色构成的软件公司](./resources/software_company_cd.jpeg) +![A software company consists of LLM-based roles](docs/resources/software_company_cd.jpeg) -

软件公司多角色示意图（正在逐步实现）

+

Software Company Multi-Role Schematic (Gradually Implementing)

-## 示例（均由 GPT-4 生成） +## Examples (fully generated by GPT-4) -例如，键入`python startup.py "写个类似今日头条的推荐系统"`并回车，你会获得一系列输出，其一是数据结构与API设计 +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 -![今日头条 Recsys 数据 & API 设计](resources/workspace/content_rec_sys/resources/data_api_design.png) +![Jinri Toutiao Recsys Data & API Design](docs/resources/workspace/content_rec_sys/resources/data_api_design.png) -这需要大约**0.2美元**（GPT-4 API的费用）来生成一个带有分析和设计的示例，大约2.0美元用于一个完整的项目 +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 -# 第 1 步：确保您的系统上安装了 NPM。并使用npm安装mermaid-js +# Step 1: Ensure that NPM is installed on your system. Then install mermaid-js. npm --version sudo npm install -g @mermaid-js/mermaid-cli -# 第 2 步：确保您的系统上安装了 Python 3.9+。您可以使用以下命令进行检查： +# Step 2: Ensure that Python 3.9+ is installed on your system. You can check this by using: python --version -# 第 3 步：克隆仓库到您的本地机器，并进行安装。 +# 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 -- 在 `config/key.yaml / config/config.yaml / env` 中配置您的 `OPENAI_API_KEY` -- 优先级顺序：`config/key.yaml > config/config.yaml > env` +- 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 ``` -| 变量名 | config/key.yaml | env | +| Variable Name | config/key.yaml | env | |--------------------------------------------|-------------------------------------------|--------------------------------| -| OPENAI_API_KEY # 用您自己的密钥替换 | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." | -| OPENAI_API_BASE # 可选 | OPENAI_API_BASE: "https:///v1" | export OPENAI_API_BASE="https:///v1" | +| 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:///v1" | export OPENAI_API_BASE="https:///v1" | -## 示例：启动一个创业公司 +## Tutorial: Initiating a startup ```shell -python startup.py "写一个命令行贪吃蛇" +python startup.py "Write a cli snake game" ``` -运行脚本后，您可以在 `workspace/` 目录中找到您的新项目。 +After running the script, you can find your new project in the `workspace/` directory. -### 代码实现 +### Code walkthrough ```python from metagpt.software_company import SoftwareCompany from metagpt.roles import ProjectManager, ProductManager, Architect, Engineer async def startup(idea: str, investment: str = '$3.0', n_round: int = 5): - """运行一个创业公司。做一个老板""" + """Run a startup. Be a boss.""" company = SoftwareCompany() company.hire([ProductManager(), Architect(), ProjectManager(), Engineer()]) company.invest(investment) @@ -86,26 +86,17 @@ ### 代码实现 await company.run(n_round=n_round) ``` -你可以查看`examples`，其中有单角色（带知识库）的使用例子与仅LLM的使用例子。 +You can check `examples` for more details on single role (with knowledge base) and LLM only examples. -## 联系信息 +## Contact Information -如果您对这个项目有任何问题或反馈，欢迎联系我们。我们非常欢迎您的建议！ +If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your suggestions! -- **邮箱：** alexanderwu@fuzhi.ai -- **GitHub 问题：** 对于更技术性的问题，您也可以在我们的 [GitHub 仓库](https://github.com/geekan/metagpt/issues) 中创建一个新的问题。 +- **Email:** alexanderwu@fuzhi.ai +- **GitHub Issues:** For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/geekan/metagpt/issues). -我们会在2-3个工作日内回复所有问题。 +We will respond to all questions within 2-3 business days. -## 演示 +## Demo https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d - -## 加入微信讨论群 - -- 群已满，加人进群 - -[//]: # (![MetaGPT WeChat Discuss Group](./resources/MetaGPT-WeChat-Group.jpeg){:height="50%" width="50%"}) -MetaGPT WeChat Discuss Group - - diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index 2bc314200..000000000 --- a/README_EN.md +++ /dev/null @@ -1,102 +0,0 @@ -# MetaGPT: The Multi-Agent Meta Programming Framework - -

-MetaGPT logo: Enable GPT to work in software company, collaborating to tackle more complex tasks. -

- -

-Make GPTs form a software company to collaboratively handle more complex tasks. -

- -

-CN doc -EN doc -Discord Follow -License: MIT -Twitter Follow -

- -1. MetaGPT takes a **single sentence of a boss's requirement** as input and outputs **user stories / competitive analysis / requirements / data structures / APIs / documents, etc.** -2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire process of a **software company along with carefully orchestrated SOPs.** - 1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs. - -![A software company consists of LLM-based roles](./resources/software_company_cd.jpeg) - -

Software Company Multi-Role Schematic (Gradually Implementing)

- -## 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 - -![Jinri Toutiao Recsys Data & API Design](resources/workspace/content_rec_sys/resources/data_api_design.png) - -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:///v1" | export OPENAI_API_BASE="https:///v1" | - -## Tutorial: Initiating a startup - -```shell -python startup.py "Write a cli snake game" -``` - -After running the script, you can find your new project in the `workspace/` directory. - -### Code walkthrough - -```python -from metagpt.software_company import SoftwareCompany -from metagpt.roles import ProjectManager, ProductManager, Architect, Engineer - -async def startup(idea: str, investment: str = '$3.0', n_round: int = 5): - """Run a startup. Be a boss.""" - company = SoftwareCompany() - company.hire([ProductManager(), Architect(), ProjectManager(), Engineer()]) - company.invest(investment) - company.start_project(idea) - await company.run(n_round=n_round) -``` - -You can check `examples` for more details on single role (with knowledge base) and LLM only examples. - -## Contact Information - -If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your suggestions! - -- **Email:** alexanderwu@fuzhi.ai -- **GitHub Issues:** For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/geekan/metagpt/issues). - -We will respond to all questions within 2-3 business days. - -## Demo - -https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d diff --git a/docs/README_CN.md b/docs/README_CN.md new file mode 100644 index 000000000..66c67d803 --- /dev/null +++ b/docs/README_CN.md @@ -0,0 +1,111 @@ +# MetaGPT：多智能体元编程框架 + +

+MetaGPT logo: 使 GPT 以软件公司的形式工作，协作处理更复杂的任务 +

+ +

+使 GPTs 组成软件公司，协作处理更复杂的任务 +

+ +

+CN doc +EN doc +Discord Follow +License: MIT +Twitter Follow +

+ +1. MetaGPT输入**一句话的老板需求**，输出**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等** +2. MetaGPT内部包括**产品经理 / 架构师 / 项目经理 / 工程师**，它提供了一个**软件公司**的全过程与精心调配的SOP + 1. `Code = SOP(Team)` 是核心哲学。我们将SOP具象化，并且用于LLM构成的团队 + +![一个完全由大语言模型角色构成的软件公司](resources/software_company_cd.jpeg) + +

软件公司多角色示意图（正在逐步实现）

+ +## 示例（均由 GPT-4 生成） + +例如，键入`python startup.py "写个类似今日头条的推荐系统"`并回车，你会获得一系列输出，其一是数据结构与API设计 + +![今日头条 Recsys 数据 & API 设计](resources/workspace/content_rec_sys/resources/data_api_design.png) + +这需要大约**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:///v1" | export OPENAI_API_BASE="https:///v1" | + +## 示例：启动一个创业公司 + +```shell +python startup.py "写一个命令行贪吃蛇" +``` + +运行脚本后，您可以在 `workspace/` 目录中找到您的新项目。 + +### 代码实现 + +```python +from metagpt.software_company import SoftwareCompany +from metagpt.roles import ProjectManager, ProductManager, Architect, Engineer + +async def startup(idea: str, investment: str = '$3.0', n_round: int = 5): + """运行一个创业公司。做一个老板""" + company = SoftwareCompany() + company.hire([ProductManager(), Architect(), ProjectManager(), Engineer()]) + company.invest(investment) + company.start_project(idea) + await company.run(n_round=n_round) +``` + +你可以查看`examples`，其中有单角色（带知识库）的使用例子与仅LLM的使用例子。 + +## 联系信息 + +如果您对这个项目有任何问题或反馈，欢迎联系我们。我们非常欢迎您的建议！ + +- **邮箱：** alexanderwu@fuzhi.ai +- **GitHub 问题：** 对于更技术性的问题，您也可以在我们的 [GitHub 仓库](https://github.com/geekan/metagpt/issues) 中创建一个新的问题。 + +我们会在2-3个工作日内回复所有问题。 + +## 演示 + +https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d + +## 加入微信讨论群 + +- 群已满，加人进群 + +[//]: # (![MetaGPT WeChat Discuss Group](./resources/MetaGPT-WeChat-Group.jpeg){:height="50%" width="50%"}) +MetaGPT WeChat Discuss Group + + diff --git a/resources/MetaGPT-WeChat-Group-Simple.png b/docs/resources/MetaGPT-WeChat-Group-Simple.png similarity index 100% rename from resources/MetaGPT-WeChat-Group-Simple.png rename to docs/resources/MetaGPT-WeChat-Group-Simple.png diff --git a/resources/MetaGPT-WeChat-Group.jpeg b/docs/resources/MetaGPT-WeChat-Group.jpeg similarity index 100% rename from resources/MetaGPT-WeChat-Group.jpeg rename to docs/resources/MetaGPT-WeChat-Group.jpeg diff --git a/resources/MetaGPT-WeChat-Personal.jpeg b/docs/resources/MetaGPT-WeChat-Personal.jpeg similarity index 100% rename from resources/MetaGPT-WeChat-Personal.jpeg rename to docs/resources/MetaGPT-WeChat-Personal.jpeg diff --git a/resources/MetaGPT-logo.jpeg b/docs/resources/MetaGPT-logo.jpeg similarity index 100% rename from resources/MetaGPT-logo.jpeg rename to docs/resources/MetaGPT-logo.jpeg diff --git a/resources/MetaGPT-logo.png b/docs/resources/MetaGPT-logo.png similarity index 100% rename from resources/MetaGPT-logo.png rename to docs/resources/MetaGPT-logo.png diff --git a/resources/software_company_cd.jpeg b/docs/resources/software_company_cd.jpeg similarity index 100% rename from resources/software_company_cd.jpeg rename to docs/resources/software_company_cd.jpeg diff --git a/resources/software_company_sd.jpeg b/docs/resources/software_company_sd.jpeg similarity index 100% rename from resources/software_company_sd.jpeg rename to docs/resources/software_company_sd.jpeg diff --git a/resources/workspace/content_rec_sys/resources/competitive_analysis.pdf b/docs/resources/workspace/content_rec_sys/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/content_rec_sys/resources/competitive_analysis.pdf rename to docs/resources/workspace/content_rec_sys/resources/competitive_analysis.pdf diff --git a/resources/workspace/content_rec_sys/resources/competitive_analysis.png b/docs/resources/workspace/content_rec_sys/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/content_rec_sys/resources/competitive_analysis.png rename to docs/resources/workspace/content_rec_sys/resources/competitive_analysis.png diff --git a/resources/workspace/content_rec_sys/resources/competitive_analysis.svg b/docs/resources/workspace/content_rec_sys/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/content_rec_sys/resources/competitive_analysis.svg rename to docs/resources/workspace/content_rec_sys/resources/competitive_analysis.svg diff --git a/resources/workspace/content_rec_sys/resources/data_api_design.pdf b/docs/resources/workspace/content_rec_sys/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/content_rec_sys/resources/data_api_design.pdf rename to docs/resources/workspace/content_rec_sys/resources/data_api_design.pdf diff --git a/resources/workspace/content_rec_sys/resources/data_api_design.png b/docs/resources/workspace/content_rec_sys/resources/data_api_design.png similarity index 100% rename from resources/workspace/content_rec_sys/resources/data_api_design.png rename to docs/resources/workspace/content_rec_sys/resources/data_api_design.png diff --git a/resources/workspace/content_rec_sys/resources/data_api_design.svg b/docs/resources/workspace/content_rec_sys/resources/data_api_design.svg similarity index 100% rename from resources/workspace/content_rec_sys/resources/data_api_design.svg rename to docs/resources/workspace/content_rec_sys/resources/data_api_design.svg diff --git a/resources/workspace/content_rec_sys/resources/seq_flow.pdf b/docs/resources/workspace/content_rec_sys/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/content_rec_sys/resources/seq_flow.pdf rename to docs/resources/workspace/content_rec_sys/resources/seq_flow.pdf diff --git a/resources/workspace/content_rec_sys/resources/seq_flow.png b/docs/resources/workspace/content_rec_sys/resources/seq_flow.png similarity index 100% rename from resources/workspace/content_rec_sys/resources/seq_flow.png rename to docs/resources/workspace/content_rec_sys/resources/seq_flow.png diff --git a/resources/workspace/content_rec_sys/resources/seq_flow.svg b/docs/resources/workspace/content_rec_sys/resources/seq_flow.svg similarity index 100% rename from resources/workspace/content_rec_sys/resources/seq_flow.svg rename to docs/resources/workspace/content_rec_sys/resources/seq_flow.svg diff --git a/resources/workspace/llmops_framework/resources/competitive_analysis.pdf b/docs/resources/workspace/llmops_framework/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/llmops_framework/resources/competitive_analysis.pdf rename to docs/resources/workspace/llmops_framework/resources/competitive_analysis.pdf diff --git a/resources/workspace/llmops_framework/resources/competitive_analysis.png b/docs/resources/workspace/llmops_framework/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/llmops_framework/resources/competitive_analysis.png rename to docs/resources/workspace/llmops_framework/resources/competitive_analysis.png diff --git a/resources/workspace/llmops_framework/resources/competitive_analysis.svg b/docs/resources/workspace/llmops_framework/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/llmops_framework/resources/competitive_analysis.svg rename to docs/resources/workspace/llmops_framework/resources/competitive_analysis.svg diff --git a/resources/workspace/llmops_framework/resources/data_api_design.pdf b/docs/resources/workspace/llmops_framework/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/llmops_framework/resources/data_api_design.pdf rename to docs/resources/workspace/llmops_framework/resources/data_api_design.pdf diff --git a/resources/workspace/llmops_framework/resources/data_api_design.png b/docs/resources/workspace/llmops_framework/resources/data_api_design.png similarity index 100% rename from resources/workspace/llmops_framework/resources/data_api_design.png rename to docs/resources/workspace/llmops_framework/resources/data_api_design.png diff --git a/resources/workspace/llmops_framework/resources/data_api_design.svg b/docs/resources/workspace/llmops_framework/resources/data_api_design.svg similarity index 100% rename from resources/workspace/llmops_framework/resources/data_api_design.svg rename to docs/resources/workspace/llmops_framework/resources/data_api_design.svg diff --git a/resources/workspace/llmops_framework/resources/seq_flow.pdf b/docs/resources/workspace/llmops_framework/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/llmops_framework/resources/seq_flow.pdf rename to docs/resources/workspace/llmops_framework/resources/seq_flow.pdf diff --git a/resources/workspace/llmops_framework/resources/seq_flow.png b/docs/resources/workspace/llmops_framework/resources/seq_flow.png similarity index 100% rename from resources/workspace/llmops_framework/resources/seq_flow.png rename to docs/resources/workspace/llmops_framework/resources/seq_flow.png diff --git a/resources/workspace/llmops_framework/resources/seq_flow.svg b/docs/resources/workspace/llmops_framework/resources/seq_flow.svg similarity index 100% rename from resources/workspace/llmops_framework/resources/seq_flow.svg rename to docs/resources/workspace/llmops_framework/resources/seq_flow.svg diff --git a/resources/workspace/match3_puzzle_game/resources/competitive_analysis.pdf b/docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/competitive_analysis.pdf rename to docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.pdf diff --git a/resources/workspace/match3_puzzle_game/resources/competitive_analysis.png b/docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/competitive_analysis.png rename to docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.png diff --git a/resources/workspace/match3_puzzle_game/resources/competitive_analysis.svg b/docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/competitive_analysis.svg rename to docs/resources/workspace/match3_puzzle_game/resources/competitive_analysis.svg diff --git a/resources/workspace/match3_puzzle_game/resources/data_api_design.pdf b/docs/resources/workspace/match3_puzzle_game/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/data_api_design.pdf rename to docs/resources/workspace/match3_puzzle_game/resources/data_api_design.pdf diff --git a/resources/workspace/match3_puzzle_game/resources/data_api_design.png b/docs/resources/workspace/match3_puzzle_game/resources/data_api_design.png similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/data_api_design.png rename to docs/resources/workspace/match3_puzzle_game/resources/data_api_design.png diff --git a/resources/workspace/match3_puzzle_game/resources/data_api_design.svg b/docs/resources/workspace/match3_puzzle_game/resources/data_api_design.svg similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/data_api_design.svg rename to docs/resources/workspace/match3_puzzle_game/resources/data_api_design.svg diff --git a/resources/workspace/match3_puzzle_game/resources/seq_flow.pdf b/docs/resources/workspace/match3_puzzle_game/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/seq_flow.pdf rename to docs/resources/workspace/match3_puzzle_game/resources/seq_flow.pdf diff --git a/resources/workspace/match3_puzzle_game/resources/seq_flow.png b/docs/resources/workspace/match3_puzzle_game/resources/seq_flow.png similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/seq_flow.png rename to docs/resources/workspace/match3_puzzle_game/resources/seq_flow.png diff --git a/resources/workspace/match3_puzzle_game/resources/seq_flow.svg b/docs/resources/workspace/match3_puzzle_game/resources/seq_flow.svg similarity index 100% rename from resources/workspace/match3_puzzle_game/resources/seq_flow.svg rename to docs/resources/workspace/match3_puzzle_game/resources/seq_flow.svg diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.pdf b/docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.pdf rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.pdf diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.png b/docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.png rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.png diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.svg b/docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.svg rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.svg diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.pdf b/docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.pdf rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.pdf diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.png b/docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.png similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.png rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.png diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.svg b/docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.svg similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.svg rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.svg diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.pdf b/docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.pdf rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.pdf diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.png b/docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.png similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.png rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.png diff --git a/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.svg b/docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.svg similarity index 100% rename from resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.svg rename to docs/resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.svg diff --git a/resources/workspace/pyrogue/resources/competitive_analysis.pdf b/docs/resources/workspace/pyrogue/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/pyrogue/resources/competitive_analysis.pdf rename to docs/resources/workspace/pyrogue/resources/competitive_analysis.pdf diff --git a/resources/workspace/pyrogue/resources/competitive_analysis.png b/docs/resources/workspace/pyrogue/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/pyrogue/resources/competitive_analysis.png rename to docs/resources/workspace/pyrogue/resources/competitive_analysis.png diff --git a/resources/workspace/pyrogue/resources/competitive_analysis.svg b/docs/resources/workspace/pyrogue/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/pyrogue/resources/competitive_analysis.svg rename to docs/resources/workspace/pyrogue/resources/competitive_analysis.svg diff --git a/resources/workspace/pyrogue/resources/data_api_design.pdf b/docs/resources/workspace/pyrogue/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/pyrogue/resources/data_api_design.pdf rename to docs/resources/workspace/pyrogue/resources/data_api_design.pdf diff --git a/resources/workspace/pyrogue/resources/data_api_design.png b/docs/resources/workspace/pyrogue/resources/data_api_design.png similarity index 100% rename from resources/workspace/pyrogue/resources/data_api_design.png rename to docs/resources/workspace/pyrogue/resources/data_api_design.png diff --git a/resources/workspace/pyrogue/resources/data_api_design.svg b/docs/resources/workspace/pyrogue/resources/data_api_design.svg similarity index 100% rename from resources/workspace/pyrogue/resources/data_api_design.svg rename to docs/resources/workspace/pyrogue/resources/data_api_design.svg diff --git a/resources/workspace/pyrogue/resources/seq_flow.pdf b/docs/resources/workspace/pyrogue/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/pyrogue/resources/seq_flow.pdf rename to docs/resources/workspace/pyrogue/resources/seq_flow.pdf diff --git a/resources/workspace/pyrogue/resources/seq_flow.png b/docs/resources/workspace/pyrogue/resources/seq_flow.png similarity index 100% rename from resources/workspace/pyrogue/resources/seq_flow.png rename to docs/resources/workspace/pyrogue/resources/seq_flow.png diff --git a/resources/workspace/pyrogue/resources/seq_flow.svg b/docs/resources/workspace/pyrogue/resources/seq_flow.svg similarity index 100% rename from resources/workspace/pyrogue/resources/seq_flow.svg rename to docs/resources/workspace/pyrogue/resources/seq_flow.svg diff --git a/resources/workspace/search_algorithm_framework/resources/competitive_analysis.pdf b/docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.pdf similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/competitive_analysis.pdf rename to docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.pdf diff --git a/resources/workspace/search_algorithm_framework/resources/competitive_analysis.png b/docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.png similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/competitive_analysis.png rename to docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.png diff --git a/resources/workspace/search_algorithm_framework/resources/competitive_analysis.svg b/docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.svg similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/competitive_analysis.svg rename to docs/resources/workspace/search_algorithm_framework/resources/competitive_analysis.svg diff --git a/resources/workspace/search_algorithm_framework/resources/data_api_design.pdf b/docs/resources/workspace/search_algorithm_framework/resources/data_api_design.pdf similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/data_api_design.pdf rename to docs/resources/workspace/search_algorithm_framework/resources/data_api_design.pdf diff --git a/resources/workspace/search_algorithm_framework/resources/data_api_design.png b/docs/resources/workspace/search_algorithm_framework/resources/data_api_design.png similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/data_api_design.png rename to docs/resources/workspace/search_algorithm_framework/resources/data_api_design.png diff --git a/resources/workspace/search_algorithm_framework/resources/data_api_design.svg b/docs/resources/workspace/search_algorithm_framework/resources/data_api_design.svg similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/data_api_design.svg rename to docs/resources/workspace/search_algorithm_framework/resources/data_api_design.svg diff --git a/resources/workspace/search_algorithm_framework/resources/seq_flow.pdf b/docs/resources/workspace/search_algorithm_framework/resources/seq_flow.pdf similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/seq_flow.pdf rename to docs/resources/workspace/search_algorithm_framework/resources/seq_flow.pdf diff --git a/resources/workspace/search_algorithm_framework/resources/seq_flow.png b/docs/resources/workspace/search_algorithm_framework/resources/seq_flow.png similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/seq_flow.png rename to docs/resources/workspace/search_algorithm_framework/resources/seq_flow.png diff --git a/resources/workspace/search_algorithm_framework/resources/seq_flow.svg b/docs/resources/workspace/search_algorithm_framework/resources/seq_flow.svg similarity index 100% rename from resources/workspace/search_algorithm_framework/resources/seq_flow.svg rename to docs/resources/workspace/search_algorithm_framework/resources/seq_flow.svg diff --git a/setup.py b/setup.py index e90fd04b2..1cdfa1169 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ class InstallMermaidCLI(Command): here = path.abspath(path.dirname(__file__)) -with open(path.join(here, "README_EN.md"), encoding="utf-8") as f: +with open(path.join(here, "README.md"), encoding="utf-8") as f: long_description = f.read() with open(path.join(here, "requirements.txt"), encoding="utf-8") as f: