diff --git a/README.md b/README.md index 0606d2be6..a39b509df 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ # Step 3: run the startup.py # setup your OPENAI_API_KEY in key.yaml copy from config.yaml python3 startup.py "Write a cli snake game" -# Step 4 [Optional]: If you want to save the artifacts like PRD in the workspace, you can execute the step before Step 3. By default, the framework is compatible, and the entire process can be run completely without executing this step. +# Step 4 [Optional]: If you want to save the artifacts like diagrams such as quadrant chart, system designs, sequence flow in the workspace, you can execute the step before Step 3. 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 diff --git a/docs/README_CN.md b/docs/README_CN.md index d38d6908b..50cf207b4 100644 --- a/docs/README_CN.md +++ b/docs/README_CN.md @@ -52,7 +52,7 @@ # 第 3 步:执行startup.py # 拷贝config.yaml为key.yaml,并设置你自己的OPENAI_API_KEY python3 startup.py "Write a cli snake game" -# 第 4 步【可选的】:如果你想在执行过程中保存像PRD文件这些产物,可以在第3步前执行该步骤。默认的,框架做了兼容,在不执行该步的情况下,也可以完整跑完整个流程。 +# 第 4 步【可选的】:如果你想在执行过程中保存像象限图、系统设计、序列流程等图表这些产物,可以在第3步前执行该步骤。默认的,框架做了兼容,在不执行该步的情况下,也可以完整跑完整个流程。 # 如果执行,确保您的系统上安装了 NPM。并使用npm安装mermaid-js npm --version sudo npm install -g @mermaid-js/mermaid-cli