From f1e97d3eb0b1451370845201821ab0056a6d6e09 Mon Sep 17 00:00:00 2001 From: EC <2340896+cyfyifanchen@users.noreply.github.com> Date: Thu, 29 Aug 2024 02:53:14 +0800 Subject: [PATCH] Removing property.json part in all READMEs. (#257) * Swapping the order of creating env and creating property.json * Revert "Swapping the order of creating env and creating property.json" This reverts commit 5f81393f68fdf46bb8535ff6224ff1126066253e. * Fixing the url of banner img * Update .gitignore * Consistency chagne * Typo * Change * Update README.md --- README.md | 8 ++++---- docs/readmes/README-ES.md | 3 +-- docs/readmes/README-FR.md | 3 +-- docs/readmes/README-IT.md | 3 +-- docs/readmes/README-JP.md | 6 +----- docs/readmes/README-KR.md | 6 +----- 6 files changed, 9 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index eaa31dc6..c1e8e146 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,9 @@ You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silico ### Next step #### 1. Modify config files -In the root of the project, use the following command to create `.env` from the examples. +In the root of the project, use `cp` command to create `.env` from the example. -They will be used to store information for `docker compose` later. +It will be used to store information for `docker compose` later. ```bash cp ./.env.example ./.env ``` @@ -115,11 +115,11 @@ make run-server ### Finish and verify 🎉 #### Astra multimodal agent -Open up http://localhost:3000 in browser to test Astra multimodal agent. +Open up http://localhost:3000 in browser to play and test the Astra agent. #### Graph designer -Open up another tab go to http://localhost:3001, and use graph designer to edit the flow and properties of any extensions. +Open up another tab go to http://localhost:3001, and use Graph Designer to create, connect and edit extensions on canvas. ![TEN Graph Designer](https://github.com/TEN-framework/docs/blob/main/assets/gifs/graph-designer.gif?raw=true) diff --git a/docs/readmes/README-ES.md b/docs/readmes/README-ES.md index e11c5412..9589139e 100644 --- a/docs/readmes/README-ES.md +++ b/docs/readmes/README-ES.md @@ -67,12 +67,11 @@ Si está utilizando Apple Silicon, deberá desmarcar la opción "Use Rosetta for ### Siguiente paso #### 1. Modificar archivos de configuración -En la raíz del proyecto, usa el siguiente comando para crear `.env` y `./agents/property.json` a partir de los ejemplos. +En la raíz del proyecto, usa el siguiente comando para crear .env a partir del ejemplo. Se utilizarán para almacenar información para `docker compose` más adelante. ```bash cp ./.env.example ./.env -cp ./agents/property.json.example ./agents/property.json ``` #### 2. Configurar claves de API diff --git a/docs/readmes/README-FR.md b/docs/readmes/README-FR.md index d1292cba..41a88925 100644 --- a/docs/readmes/README-FR.md +++ b/docs/readmes/README-FR.md @@ -66,12 +66,11 @@ Si vous utilisez Apple Silicon, vous devrez décocher l'option "Utiliser Rosetta ### Étape suivante #### 1. Modifier les fichiers de configuration -À la racine du projet, utilisez la commande suivante pour créer les fichiers `.env` et `./agents/property.json` à partir des exemples. +À la racine du projet, utilisez la commande cp pour créer .env à partir de l’exemple. Ils seront utilisés pour stocker les informations pour `docker compose` ultérieurement. ```bash cp ./.env.example ./.env -cp ./agents/property.json.example ./agents/property.json ``` #### 2. Configuration des clés API diff --git a/docs/readmes/README-IT.md b/docs/readmes/README-IT.md index 9cf0cf30..6d9a9f2a 100644 --- a/docs/readmes/README-IT.md +++ b/docs/readmes/README-IT.md @@ -66,12 +66,11 @@ Se si utilizza Apple Silicon, è necessario deselezionare l'opzione "Use Rosetta ### Prossimo passo #### 1. Modifica dei file di configurazione -Nella root del progetto, utilizza il seguente comando per creare `.env` e `./agents/property.json` dagli esempi. +Nella radice del progetto, usa il comando cp per creare .env dall’esempio. Verranno utilizzati per memorizzare le informazioni per `docker compose` successivamente. ```bash cp ./.env.example ./.env -cp ./agents/property.json.example ./agents/property.json ``` #### 2. Configurazione delle chiavi API diff --git a/docs/readmes/README-JP.md b/docs/readmes/README-JP.md index c0bcbf43..7d0156e1 100644 --- a/docs/readmes/README-JP.md +++ b/docs/readmes/README-JP.md @@ -71,13 +71,9 @@ Apple Silicon Mac を使用している場合は、Docker の "Use Rosetta for x ### 次のステップ #### 1. 設定ファイルの準備 -プロジェクトをクローンした後、ルートディレクトリで以下のコマンドを実行して `property.json` と `.env` を作成します： +プロジェクトのルートで、`cp` コマンドを使って、サンプルから `.env` を作成してください。 ```bash -# .env ファイルの作成 cp ./.env.example ./.env - -# property.json ファイルの作成 -cp ./agents/property.json.example ./agents/property.json ``` #### 2. キーのバインド diff --git a/docs/readmes/README-KR.md b/docs/readmes/README-KR.md index 784ce535..580e0b77 100644 --- a/docs/readmes/README-KR.md +++ b/docs/readmes/README-KR.md @@ -65,13 +65,9 @@ Apple Silicon을 사용하는 경우 Docker의 "Use Rosetta for x86_64/amd64 emu ### 다음 단계 #### 1. 설정 파일 수정 -프로젝트 루트에서 예제 파일로부터 이 파일들을 생성하세요. 나중에 Docker Compose를 위한 정보를 저장하는 데 사용됩니다. +프로젝트의 루트에서 `cp` 명령어를 사용하여 예시에서 `.env` 파일을 생성하세요. ```bash -# .env 예제로부터 .env 생성 cp ./.env.example ./.env - -# property.json 예제로부터 property.json 생성 -cp ./agents/property.json.example ./agents/property.json ``` #### 2. API 키 설정