diff --git a/README.md b/README.md index b1e470e..4d78c79 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,8 @@ git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git cd Code-Review-GPT-Gitlab +cp ./config/config.py.example ./config/config.py + vim ./config/config.py docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest @@ -195,6 +197,7 @@ pip install -r requirements.txt ``` 3.**修改配置文件** ```bash +cp ./config/config.py.example ./config/config.py vim config/config.py ``` diff --git a/README_EN.md b/README_EN.md index 25838ec..088067d 100644 --- a/README_EN.md +++ b/README_EN.md @@ -129,6 +129,21 @@ The default supported models are listed in the table below. # Usage 📖 ### install + +#### Run by Docker + +```bash +git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git + +cd Code-Review-GPT-Gitlab + +cp ./config/config.py.example ./config/config.py + +vim ./config/config.py + +docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest +``` + #### Run by Source code 1.**clone repo** ```bash @@ -140,6 +155,7 @@ pip install -r requirements.txt ``` 3.**modify config file** ```bash +cp ./config/config.py.example ./config/config.py vim config/config.py ``` 4.**run** diff --git a/config/config.py b/config/config.py.example similarity index 100% rename from config/config.py rename to config/config.py.example