From 9a518ef4acb269dbefa879c169ff9e7c5d31584b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20=C5=81azicki?= Date: Sat, 14 Oct 2023 02:00:13 +0200 Subject: [PATCH 1/4] docs: Update wiki.md to refer to README.md quickstart instructions --- wiki.md | 32 +++----------------------------- 1 file changed, 3 insertions(+), 29 deletions(-) diff --git a/wiki.md b/wiki.md index 71b9e093..c56f313e 100644 --- a/wiki.md +++ b/wiki.md @@ -4,33 +4,7 @@ ### 1. Install `ChatDev`: -- **Clone the GitHub Repository:** Begin by cloning the repository using the command: - ``` - git clone https://github.com/OpenBMB/ChatDev.git - ``` -- **Set Up Python Environment:** Ensure you have a Python environment of version 3.9 or higher. You can create and - activate this environment using the following commands, replacing `ChatDev_conda_env` with your preferred environment - name: - ``` - conda create -n ChatDev_conda_env python=3.9 -y - conda activate ChatDev_conda_env - ``` -- **Install Dependencies:** Move into the `ChatDev` directory and install the necessary dependencies by running: - ``` - cd ChatDev - pip3 install -r requirements.txt - ``` -- **Set OpenAI API Key:** Export your OpenAI API key as an environment variable. Replace `"your_OpenAI_API_key"` with - your actual API key. Remember that this environment variable is session-specific, so you'll need to set it again if - you open a new terminal session. - On Unix/Linux: - ``` - export OPENAI_API_KEY="your_OpenAI_API_key" - ``` - On Windows: - ``` - $env:OPENAI_API_KEY="your_OpenAI_API_key" - ``` +- Visit the [quickstart section](README.md#⚡️-quickstart) of readme for installation instructions. ### 2. Start building software in one command: @@ -45,9 +19,9 @@ ```commandline usage: run.py [-h] [--config CONFIG] [--org ORG] [--task TASK] [--name NAME] [--model MODEL] - + argparse - + optional arguments: -h, --help show this help message and exit --config CONFIG Name of config, which is used to load configuration under CompanyConfig/; Please see CompanyConfig Section below From 4a7b8148c53a301b259f1b50b9a0bae8547f4f15 Mon Sep 17 00:00:00 2001 From: Prashanth Date: Sun, 22 Oct 2023 19:34:14 -0400 Subject: [PATCH 2/4] Updated typo in wiki.md --- wiki.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki.md b/wiki.md index 71b9e093..cb993d6f 100644 --- a/wiki.md +++ b/wiki.md @@ -88,7 +88,7 @@ ## Local Demo -- you can start a flask app fist get a local demo, including enhanced visualized logs, replay demo, and a simple +- you can start a flask app first to get a local demo, including enhanced visualized logs, replay demo, and a simple ChatChain Visualizer. ``` From 42c3e6dfcf5cb5e7ddafd7c206d1e05ab011fd05 Mon Sep 17 00:00:00 2001 From: thinkwee Date: Mon, 23 Oct 2023 10:16:27 +0800 Subject: [PATCH 3/4] remove redundant software --- WareHouse/ChatDev | 1 - WareHouse/ChatDevClone | 1 - WareHouse/Gomoku_DefaultOrganization_20230925190506 | 1 - WareHouse/Gomoku_DefaultOrganization_20230925203816 | 1 - 4 files changed, 4 deletions(-) delete mode 160000 WareHouse/ChatDev delete mode 160000 WareHouse/ChatDevClone delete mode 160000 WareHouse/Gomoku_DefaultOrganization_20230925190506 delete mode 160000 WareHouse/Gomoku_DefaultOrganization_20230925203816 diff --git a/WareHouse/ChatDev b/WareHouse/ChatDev deleted file mode 160000 index e9657636..00000000 --- a/WareHouse/ChatDev +++ /dev/null @@ -1 +0,0 @@ -Subproject commit e9657636f66293a61b211b414180435d22bfe8c2 diff --git a/WareHouse/ChatDevClone b/WareHouse/ChatDevClone deleted file mode 160000 index 808cab1c..00000000 --- a/WareHouse/ChatDevClone +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 808cab1c21f34c4bf8be161552651bf7fc50acda diff --git a/WareHouse/Gomoku_DefaultOrganization_20230925190506 b/WareHouse/Gomoku_DefaultOrganization_20230925190506 deleted file mode 160000 index 5f7c9d5f..00000000 --- a/WareHouse/Gomoku_DefaultOrganization_20230925190506 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5f7c9d5f1d26497c43cf1a274e7adc2f8ab09ea1 diff --git a/WareHouse/Gomoku_DefaultOrganization_20230925203816 b/WareHouse/Gomoku_DefaultOrganization_20230925203816 deleted file mode 160000 index c581556f..00000000 --- a/WareHouse/Gomoku_DefaultOrganization_20230925203816 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit c581556f7ca408d78e4265a1dad2ad78d041d9fb From 3bab1bedd6dfb6f9a1fadf1e7a86ae67fabda83e Mon Sep 17 00:00:00 2001 From: thinkwee Date: Mon, 23 Oct 2023 10:43:11 +0800 Subject: [PATCH 4/4] fix wiki --- wiki.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki.md b/wiki.md index 7618d830..15c3b19a 100644 --- a/wiki.md +++ b/wiki.md @@ -4,7 +4,7 @@ ### 1. Install `ChatDev`: -- Visit the [quickstart section](README.md#⚡️-quickstart) of readme for installation instructions. +- Visit the [quickstart section](README.md#%EF%B8%8F-quickstart) of readme for installation instructions. ### 2. Start building software in one command: