Skip to content

Commit

Permalink
refine docs
Browse files Browse the repository at this point in the history
  • Loading branch information
geekan committed Feb 1, 2024
1 parent 097128f commit 6e4b0c1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 27 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,24 +55,20 @@

### Pip installation

> Ensure that Python 3.9+ is installed on your system. You can check this by using: `python --version`.
> Ensure that Python 3.9+ is installed on your system. You can check this by using: `python --version`.
> You can use conda like this: `conda create -n metagpt python=3.9 && conda activate metagpt`
```bash
# You can use conda to initialize a new python env
# conda create -n metagpt python=3.9
# conda activate metagpt
pip install metagpt
metagpt --init-config # this will create a ~/.metagpt/config2.yaml from config/config2.yaml, modify it to your own config

# Usage: metagpt "<create a game or a software>"
metagpt "Create a 2048 game"
metagpt --init-config # create ~/.metagpt/config2.yaml, modify it to your own config
metagpt "Create a 2048 game" # this will create a repo in ./workspace
```

or you can use it as library

```python
from metagpt.software_company import generate_repo, ProjectRepo
repo: ProjectRepo = generate_repo("Create a 2048 game") # or ProjectRepo("<path/to/your/repo>")
repo: ProjectRepo = generate_repo("Create a 2048 game") # or ProjectRepo("<path>")
print(repo) # it will print the repo structure with files
```

Expand Down
14 changes: 5 additions & 9 deletions docs/README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,20 @@
## 安装
### Pip安装

> 确保您的系统安装了 Python 3.9 或更高版本。您可以通过以下命令来检查:`python --version`
> 确保您的系统已安装 Python 3.9 或更高版本。您可以使用以下命令来检查:`python --version`
> 您可以这样使用 conda:`conda create -n metagpt python=3.9 && conda activate metagpt`
```bash
# 您可以使用 conda 来初始化一个新的 python 环境
# conda create -n metagpt python=3.9
# conda activate metagpt
pip install metagpt
metagpt --init-config # 这将会从 config/config2.yaml 创建一个 ~/.metagpt/config2.yaml,根据您的需求修改它

# 使用方法: metagpt "<创建一个游戏或软件>"
metagpt "创建一个 2048 游戏"
metagpt --init-config # 创建 ~/.metagpt/config2.yaml,根据您的需求修改它
metagpt "创建一个 2048 游戏" # 这将在 ./workspace 创建一个仓库
```

或者您可以将其作为库使用

```python
from metagpt.software_company import generate_repo, ProjectRepo
repo: ProjectRepo = generate_repo("创建一个 2048 游戏") # 或 ProjectRepo("<您的仓库路径>")
repo: ProjectRepo = generate_repo("创建一个 2048 游戏") # 或 ProjectRepo("<路径>")
print(repo) # 它将打印出仓库结构及其文件
```

Expand Down
15 changes: 6 additions & 9 deletions docs/README_JA.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,20 @@ https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace
- [Matthew Berman: How To Install MetaGPT - Build A Startup With One Prompt!!](https://youtu.be/uT75J_KG_aY)

### 伝統的なインストール
> Python 3.9 以上がシステムにインストールされていることを確認してください。これは `python --version` を使ってチェックできます。
> 以下のようにcondaを使うことができます:`conda create -n metagpt python=3.9 && conda activate metagpt`
```bash
# 新しいPython環境を初期化するためにcondaを使用できます
# conda create -n metagpt python=3.9
# conda activate metagpt
pip install metagpt
metagpt --init-config # これにより、config/config2.yaml から ~/.metagpt/config2.yaml が作成されます。自分の設定に合わせて変更してください

# 使用方法:metagpt "<ゲームまたはソフトウェアを作成する>"
metagpt "2048ゲームを作成する"
metagpt --init-config # ~/.metagpt/config2.yaml を作成し、自分の設定に合わせて変更してください
metagpt "2048ゲームを作成する" # これにより ./workspace にリポジトリが作成されます
```

また、ライブラリとして使用することもできます
または、ライブラリとして使用することもできます

```python
from metagpt.software_company import generate_repo, ProjectRepo
repo: ProjectRepo = generate_repo("2048ゲームを作成する") # または ProjectRepo("<リポジトリへのパス>")
repo: ProjectRepo = generate_repo("2048ゲームを作成する") # または ProjectRepo("<パス>")
print(repo) # リポジトリの構造とファイルを出力します
```

Expand Down

0 comments on commit 6e4b0c1

Please sign in to comment.