diff --git a/README.md b/README.md index c537e2a3b..1929a8bdd 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,8 @@ ## Install ### Pip installation ```bash -# Step 1: Ensure that NPM is installed on your system. Then install mermaid-js. (If you don't have npm in your computer, please go to the Node.js official website to install Node.js https://nodejs.org/ and then you will have npm tool in your computer.) +# Step 1 [Optional]: If you want to save the artifacts like PRD in the workspace, you can execute the step. By default, the framework is compatible, and the entire process can be run completely without executing this step. +# If executing, ensure that NPM is installed on your system. Then install mermaid-js. (If you don't have npm in your computer, please go to the Node.js official website to install Node.js https://nodejs.org/ and then you will have npm tool in your computer.) npm --version sudo npm install -g @mermaid-js/mermaid-cli @@ -51,8 +52,8 @@ # conda activate metagpt python3 --version # Step 3: Clone the repository to your local machine for latest version, and install it. -git clone https://github.com/geekan/metagpt -cd metagpt +git clone https://github.com/geekan/MetaGPT.git +cd MetaGPT pip3 install -e. # or pip3 install metagpt # for stable version # Step 4: run the startup.py diff --git a/docs/README_CN.md b/docs/README_CN.md index 22e8358b2..3e0879c1b 100644 --- a/docs/README_CN.md +++ b/docs/README_CN.md @@ -37,7 +37,8 @@ ## 安装 ### Pip安装 ```bash -# 第 1 步:确保您的系统上安装了 NPM。并使用npm安装mermaid-js +# 第 1 步【可选的】:如果你想在执行过程中保存像PRD文件这些产物,可以执行该步骤。默认的,框架做了兼容,在不执行该步的情况下,也可以完整跑完整个流程。 +# 如果执行,确保您的系统上安装了 NPM。并使用npm安装mermaid-js npm --version sudo npm install -g @mermaid-js/mermaid-cli @@ -48,8 +49,8 @@ # conda activate metagpt python3 --version # 第 3 步:克隆最新仓库到您的本地机器,并进行安装。 -git clone https://github.com/geekan/metagpt -cd metagpt +git clone https://github.com/geekan/MetaGPT.git +cd MetaGPT pip3 install -e. # 或者 pip3 install metagpt # 安装稳定版本 # 第 4 步:执行startup.py diff --git a/docs/README_JA.md b/docs/README_JA.md index 2b2c35a62..dfb9c8372 100644 --- a/docs/README_JA.md +++ b/docs/README_JA.md @@ -68,8 +68,8 @@ # ステップ 2: Python 3.9+ がシステムにインストールされてい python --version # ステップ 3: リポジトリをローカルマシンにクローンし、インストールする。 -git clone https://github.com/geekan/metagpt -cd metagpt +git clone https://github.com/geekan/MetaGPT.git +cd MetaGPT pip install -e. ``` diff --git a/docs/install/cli_install.md b/docs/install/cli_install.md index 19f0e3c75..80deda771 100644 --- a/docs/install/cli_install.md +++ b/docs/install/cli_install.md @@ -17,8 +17,8 @@ # Step 2: Ensure that Python 3.9+ is installed on your system. You can check thi python3 --version # Step 3: Clone the repository to your local machine, and install it. -git clone https://github.com/geekan/metagpt -cd metagpt +git clone https://github.com/geekan/MetaGPT.git +cd MetaGPT pip install -e. ``` diff --git a/docs/install/cli_install_cn.md b/docs/install/cli_install_cn.md index fe97a0b80..f351090ed 100644 --- a/docs/install/cli_install_cn.md +++ b/docs/install/cli_install_cn.md @@ -18,8 +18,8 @@ # 第 2 步:确保您的系统上安装了 Python 3.9+。您可以使用以下 python --version # 第 3 步:克隆仓库到您的本地机器,并进行安装。 -git clone https://github.com/geekan/metagpt -cd metagpt +git clone https://github.com/geekan/MetaGPT.git +cd MetaGPT pip install -e. ```