Auto-translate README

Lin-jun-xiang · Jan 13, 2025 · a65b06b · a65b06b
1 parent d94839d
commit a65b06b
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 97 deletions.
diff --git a/README.French.md b/README.French.md
@@ -6,37 +6,39 @@
 * [Française](README.French.md)
 
 # Introduction
-
+ 
 **GitHub Action pour traduire le Readme dans n'importe quelle langue**
 
 Il s'agit d'une GitHub Action qui traduit automatiquement le readme de votre dépôt dans une langue spécifiée.
 
 > [!NOTE]
-> La version `v1` du traducteur est implémentée via un paquet tiers sous `Linux` ; la version `v2` est implémentée via une IA générative pour la traduction.
+> La version `v1` du traducteur est implémentée via un package tiers `Linux` ; la version `v2` est implémentée via une IA générative pour la traduction.
+
 
-* Nous savons tous que rédiger des documents README est chronophage, mais il existe désormais une solution pour vous faire gagner la moitié du temps. C'est notre `action-translate-readme`.
+* Nous savons tous que rédiger des documents README est chronophage, mais il existe maintenant une solution pour gagner la moitié du temps. C'est notre `action-translate-readme`
 
-* Traduire différentes versions de READMEREADME via **IA générative**
+* Traduire différentes versions linguistiques du README via **l'IA générative**
 
 * **Commiter et pousser** automatiquement les fichiers traduits via **GitHub Actions (CI/CD)**
 
 * Par exemple : **Écrire** ou **Modifier** la version anglaise du README, générer automatiquement les versions en chinois traditionnel, chinois simplifié, français... et autres versions du README
 
-# Comment l'utiliser ?
+
+# Comment utiliser ?
 
 > [!IMPORTANT]
-> Étant donné que les résultats de la traduction par le modèle d'IA générative peuvent présenter des problèmes occasionnels, il est recommandé d'effectuer les opérations sur une branche et de fusionner ensuite avec la branche principale.
+> Étant donné que le résultat de la traduction par le modèle d'IA générative peut présenter des problèmes occasionnellement, il est recommandé d'effectuer les opérations sur une branche et de fusionner ensuite avec la branche principale.
 
-> [!AVERTISSEMENT]
-> Si vous rencontrez cette erreur : `Error: Input required and not supplied: token`, veuillez vous assurer que le `Token` est établi comme indiqué à l'étape deux ci-dessous, ou vérifiez si le `Token` a expiré !
+> [!WARNING]
+> Si vous rencontrez cette erreur : `Error: Input required and not supplied: token`, veuillez vous assurer que `Token` est établi comme indiqué à l'étape deux ci-dessous, ou vérifiez si le `Token` a expiré !
 
 1. Cliquez sur l'icône :star: pour ajouter cet élément à votre dépôt GitHub.
 
 2. Configurez votre `GitHub Token` (**obligatoire**) :
 
     1. [Créer un nouveau **`GitHub Secret Token`**](https://github.com/settings/tokens/new)
         * Paramètres
-        * Paramètres du développeur
+        * Paramètres développeur
         * Jetons d'accès personnels - `Tokens(classic)`
         * Générer un nouveau jeton
         * Choisir la **durée de vie** du jeton - il est recommandé d'utiliser **permanently**
@@ -47,34 +49,33 @@ Il s'agit d'une GitHub Action qui traduit automatiquement le readme de votre dé
 
     2. Ajoutez le GitHub Token aux **`secrets du dépôt`**
         * Dans votre dépôt - `settings`
-`
         * `Sécurité et variables`
         * `Actions`
-        * `Nouveau secret du dépôt`
-        * Remplissez l'étiquette et nommez-la `token` (par exemple, `Action_Bot`)
+        * `Nouveau secret de dépôt`
+        * Remplissez l'étiquette et nommez-le avec `token` (par exemple, `Action_Bot`)
 
         <img src="https://github.com/Lin-jun-xiang/action-translate-readme/assets/63782903/27dc7bcd-633f-431e-98e8-387b97ecd47c" width="60%" />
 
 3. Choisissez le modèle de traduction GPT (**optionnel**)
 
    * `g4f` : **Par défaut**, utilise **gratuitement** `g4f` pour les appels OpenAI afin de réaliser les tâches de traduction.
-   * `zhipuai` : Si vous avez besoin d'une traduction **gratuite et stable**, vous pouvez vous inscrire sur la [plateforme Zhipuai AI](https://open.bigmodel.cn/dev/howuse/introduction) et [demander une clé API](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys), il s'agit d'un modèle GPT entièrement gratuit sans besoin de carte de crédit.
-     * Pour utiliser cette option, suivez la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajoutez **la clé API de Zhipuai AI aux secrets du dépôt GitHub**.
+   * `zhipuai` : Si vous avez besoin d'une traduction **gratuite et stable**, vous pouvez vous inscrire sur la [Plateforme Zhipuai AI](https://open.bigmodel.cn/dev/howuse/introduction) et [demander un API KEY](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys), qui est un modèle GPT completely gratuit sans nécessiter de carte de crédit.
+     * Pour utiliser cette option, veuillez suivre la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajouter **API KEY de Zhipuai AI aux Secrets de GitHub Repos**.
 
         <img src="static/images/2025-01-02-11-25-45.png" width="60%" />
 
         <img src="static/images/2025-01-02-11-26-28.png" width="60%" />
 
-   * `openai` : **Garantit une qualité élevée et une stabilité**, si vous avez une clé API OPENAI, `gpt-4o` sera utilisé comme modèle de traduction.
-     * Pour utiliser cette option, suivez la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajoutez **la clé API d'OpenAI aux secrets du dépôt GitHub**.
+   * `openai` : **Garantit une qualité élevée et stable**, si vous avez un OPENAI API KEY, `gpt-4o` sera utilisé comme modèle de traduction.
+     * Pour utiliser cette option, veuillez suivre la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajouter **API KEY d'OpenAI aux Secrets de GitHub Repos**.
 
         <img src="static/images/2025-01-13-10-13-51.png" width="60%" />
 
 4. Créez votre exemple d'action dans `.github/workflows/your_action.yml`. Vous pouvez directement copier ce qui suit :
 
     ```yaml
     # .github/workflows/translate.yml
-    name: Traduire le Readme
+    name: Traduire Readme
 
     on:
         push:
@@ -94,24 +95,23 @@ Il s'agit d'une GitHub Action qui traduit automatiquement le readme de votre dé
                   with:
                     token: ${{ secrets.Action_Bot }} # Basé sur le nom de l'étape 2
                     zhipuai: ${{ secrets.zhipuai_api_key }} # Optionnel : Basé sur l'étape 3
-                    openai: ${{ secrets.open
-openai_api_key }}  # Optionnel : Basé sur l'étape 3
+                    openai: ${{ secrets.openai_api_key }}  # Optionnel : Basé sur l'étape 3
                     langs: "en,zh-TW,zh-CN,French,Arabic" # Vous pouvez définir n'importe quelles langues
     ```
 
     Faites attention à plusieurs paramètres dans le `.yml` :
 
-    * `token` : GitHub Token pour autoriser l'opération (ajouté comme à l'étape deux).
-    * `zhipuai` : API Zhipuai, ajoutée comme à l'étape trois (optionnel)
-    * `openai` : API OpenAI, ajoutée comme à l'étape trois (optionnel)
-    * `langs` : Spécifiez les langues à traduire, assurez-vous de séparer différentes langues par `,` comme :
+    * `token` : GitHub Token pour autoriser l'opération (ajouté comme indiqué à l'étape deux).
+    * `zhipuai` : API Zhipuai, ajouté comme indiqué à l'étape trois (optionnel)
+    * `openai` : API OpenAI, ajouté comme indiqué à l'étape trois (optionnel)
+    * `langs` : Spécifiez les langues à traduire, assurez-vous de séparer les différentes langues par `,` comme :
       * `"en"` : Traduire uniquement la version anglaise
       * `"en,zh-TW"` : Traduire l'anglais, le chinois traditionnel
       * `"French,Arabic"` : Traduire le français, l'arabe
 
-    > PS : Si ni `zhipuai` ni `openai` n'est ajouté aux secrets GitHub, `g4f` sera utilisé pour la traduction.
+    > PS : Si ni `zhipuai` ni `openai` n'est ajouté aux Secrets de GitHub, `g4f` sera utilisé pour la traduction.
 
-5. Maintenant, vous pouvez mettre à jour `README.md`, et cela générera automatiquement une version traduite !
+5. Maintenant, vous pouvez mettre à jour `README.md`, et il générera automatiquement une version traduite !
 
 ---
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -12,66 +12,64 @@
 这是一个GitHub Action，可以自动将您仓库中的readme翻译成指定的语言。
 
 > [!NOTE]
-> `v1` 版本的翻译器是通过 `Linux` 第三方包实现的；`v2` 版本是通过生成式AI进行翻译的
+> `v1` 版本的翻译器是通过 `Linux` 第三方包实现的；`v2` 版本则是通过生成式AI进行翻译。
 
-
-* 我们都知道编写README文档很耗时，但现在有一个解决方案可以为您节省一半的时间。那就是我们的 `action-translate-readme`
+* 我们都知道编写README文档非常耗时，但现在有一个解决方案可以为您节省一半的时间。这就是我们的 `action-translate-readme`
 
 * 通过**生成式AI**翻译不同语言版本的README
 
-* 通过**GitHub Actions (CI/CD)**自动**提交并推送**翻译后的文件
-
-* 例如：**编写**或**修改**英文版本的README，自动生成繁体中文、简体中文、法语...等版本的README
+* 自动通过**GitHub Actions (CI/CD)** **提交并推送**翻译后的文件
 
+* 例如：**编写**或**修改**英文版本的README，自动生成繁体中文、简体中文、法语等版本的README
 
 # How to use ?
 
 > [!IMPORTANT]
-> 由于生成式AI模型的翻译结果偶尔可能存在问题，建议在分支上进行操作，最后再合并回主分支。
+> 由于生成式AI模型的翻译结果偶尔可能会有问题，建议在分支上操作，最后再合并回主分支。
 
 > [!WARNING]
-> 如果您遇到此错误：`Error: Input required and not supplied: token`，请确保按照下面第二步建立`Token`，或者检查`Token`是否过期！
+> 如果遇到这个错误：`Error: Input required and not supplied: token`，请确保按照下面的第二步建立`Token`，或者检查`Token`是否过期！
 
 1. 点击 :star: 图标将此项目添加到您的GitHub仓库。
 
-2. 设置您的`GitHub Token`（**必填**）：
+2. 设置您的 `GitHub Token`（**必填**）：
 
-    1. [创建一个新的**`GitHub Secret Token`**](https://github.com/settings/tokens/new)
-        * Settings
-        * Developer settings
-        * Personal access tokens - `Tokens(classic)`
-        * Generate new token
-        * 选择token的**有效期** - 建议使用**永久**
+    1. [创建一个新的 **`GitHub Secret Token`**](https://github.com/settings/tokens/new)
+        * 设置
+        * 开发者设置
+        * 个人访问令牌 - `Tokens(classic)`
+        * 生成新令牌
+        * 选择令牌的**有效期** - 建议使用**永久**
         * 范围选择：`repo` 和 `workflow`
-        * **保存**您的密钥token（不要丢失，稍后需要粘贴）
+        * **保存**您的密钥令牌（不要丢失，后面需要粘贴）
 
         <img src="https://github.com/Lin-jun-xiang/action-translate-readme/assets/63782903/b7487b49-817c-4925-b94a-bdb7b025a0c2" width="60%" />
 
     2. 将GitHub Token添加到**`仓库密钥`**
-        * 在您的仓库中 - `settings`
+        * 在您的仓库中 - `设置`
         * `安全和变量`
         * `Actions`
-        * `New repository secret`
+        * `新建仓库密钥`
         * 填写标签并命名为`token`（例如，`Action_Bot`）
 
         <img src="https://github.com/Lin-jun-xiang/action-translate-readme/assets/63782903/27dc7bcd-633f-431e-98e8-387b97ecd47c" width="60%" />
 
 3. 选择GPT翻译模型（**可选**）
-   
-   * `g4f`：**默认**使用**免费**的`g4f`进行OpenAI调用以完成翻译任务。
-   * `zhipuai`：如果您需要**免费且稳定的翻译**，可以在[智谱AI平台](https://open.bigmodel.cn/dev/howuse/introduction)注册账号并[申请API KEY](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys)，这是一个完全免费的GPT模型，无需信用卡。
-     * 要使用此选项，请按照**步骤2-2**中添加GitHub Token的方法，并将**智谱AI的API KEY添加到GitHub仓库的密钥中**。
+
+   * `g4f`：**默认**使用**免费**的`g4f`进行OpenAI调用完成翻译任务。
+   * `zhipuai`：如果您需要**免费且稳定的翻译**，可以在[智谱AI平台](https://open.bigmodel.cn/dev/howuse/introduction)注册并[申请API KEY](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys)，这是一个完全免费的GPT模型，不需要信用卡。
+     * 使用此选项，请按照**第二步2-2**的方法添加GitHub Token，并将**智谱AI的API KEY添加到GitHub仓库密钥**。
 
         <img src="static/images/2025-01-02-11-25-45.png" width="60%" />
 
         <img src="static/images/2025-01-02-11-26-28.png" width="60%" />
 
-   * `openai`：**保证高质量和稳定质量**，如果您有OPENAI API KEY，将使用`gpt-4o`作为翻译模型。
-     * 要使用此选项，请按照**步骤2-2**中添加GitHub Token的方法，并将**OpenAI的API KEY添加到GitHub仓库的密钥中**。
+   * `openai`：**保证高质量和稳定的翻译**，如果您有OPENAI API KEY，将使用`gpt-4o`作为翻译模型。
+     * 使用此选项，请按照添加GitHub Token的**第二步2-2**方法，并将**OpenAI的API KEY添加到GitHub仓库密钥**。
 
         <img src="static/images/2025-01-13-10-13-51.png" width="60%" />
 
-4. 在`.github/workflows/your_action.yml`中创建您的action示例。您可以直接复制以下内容：
+4. 在`.github/workflows/your_action.yml`中创建您的操作示例。您可以直接复制以下内容：
 
     ```yaml
     # .github/workflows/translate.yml
@@ -91,11 +89,11 @@
                     fetch-depth: 3
 
                 - name: Auto Translate
-                  uses: Lin-jun-xiang/action-translate-readme@v2 # 根据标签
+                  uses: Lin-jun-xiang/action-translate-readme@v2 # 基于标签
                   with:
-                    token: ${{ secrets.Action_Bot }} # 根据步骤2的名称
-                    zhipuai: ${{ secrets.zhipuai_api_key }} # 可选：根据步骤3
-                    openai: ${{ secrets.openai_api_key }}  # 可选：根据步骤3
+                    token: ${{ secrets.Action_Bot }} # 基于第二步的命名
+                    zhipuai: ${{ secrets.zhipuai_api_key }} # 可选：基于第三步
+                    openai: ${{ secrets.openai_api_key }}  # 可选：基于第三步
                     langs: "en,zh-TW,zh-CN,French,Arabic" # 您可以定义任何语言
     ```
 
@@ -109,7 +107,7 @@
       * `"en,zh-TW"`：翻译英文、繁体中文
       * `"French,Arabic"`：翻译法语、阿拉伯语
 
-    > PS：如果未将`zhipuai`或`openai`添加到GitHub Secrets，将使用`g4f`进行翻译。
+    > PS：如果语`zhipuai`和`openai`都没有添加到GitHub Secrets，将使用`g4f`进行翻译。
 
 5. 现在您可以更新`README.md`，它将自动生成翻译版本！
 
@@ -121,6 +119,6 @@
 
 # Results of Test Document
 
-* 查看[测试文档](https://github.com/Lin-jun-xiang/ChatGPT-line-bot)，该文档使用了我们的工具进行文档更新。
+* 查看[测试文档](https://github.com/Lin-jun-xiang/ChatGPT-line-bot)，该文档使用了我们的工具更新文档。
 
 <a href="#top">Back to top</a>