diff --git a/README.Arabic.md b/README.Arabic.md index a375680..9fe3b4b 100644 --- a/README.Arabic.md +++ b/README.Arabic.md @@ -1,3 +1,4 @@ +```markdown # action-translate-readme

@@ -11,55 +12,56 @@ * [عربى](README.Arabic.md) -# المقدمة +# مقدمة > [!NOTE] -> إن مترجم الإصدار `v1` تم تنفيذه باستخدام حزمة الطرف الثالث `Linux`؛ بينما يتم تنفيذ الإصدار `v2` باستخدام [`g4f`](https://github.com/xtekky/gpt4free) لاستدعاء واجهة برمجة تطبيقات openai مجانًا للترجمة. +> إصدار `v1` من المترجم يتم تحقيقه من خلال حزم جهات خارجية في `Linux`؛ الإصدار `v2` يتم تحقيقه عن طريق استدعاء [`g4f`](https://github.com/xtekky/gpt4free) لـ openai api مجانًا للترجمة. -* نعلم جميعًا أن كتابة وثيقة README تستغرق وقتًا طويلاً ، ولكن الآن هناك حلاً يمكنك من خلاله توفير نصف الوقت. هذا هو `action-translate-readme` لدينا. +* نعلم جميعًا أن كتابة ملف README تستغرق وقتًا طويلاً، ولكن الآن هناك حلاً يمكن أن يوفر لك نصف الوقت. وهذا هو `action-translate-readme` لدينا. -* قم بترجمة إصدارات README المختلفة بواسطة `gpt3.5`. +* ترجمة إصدارات README بلغات مختلفة باستخدام `gpt3.5` -* تقديم **Github Actions(CI/CD) للترجمة التلقائية (commit، push)** للملفات المترجمة. +* تقديم ملفات README بعد الترجمة تلقائيًا عبر **Github Actions(CI/CD)** -* على سبيل المثال: **كتابة** أو **تعديل** إصدار README باللغة الإنجليزية ، ستتم إنشاء إصدارات README باللغة التايوانية التقليدية واللغة الصينية المبسطة واللغة الفرنسية وما إلى ذلك. +* على سبيل المثال: **الكتابة** أو **تعديل** ملف README باللغة الإنجليزية، ستنشأ تلقائياً إصدارات باللغة الصينية التقليدية والصينية المبسطة والفرنسية ... الخ. # كيفية الاستخدام؟ > [!IMPORTANT] -> نظرًا لأن `gpt3.5` هو نموذج AI القائم على الإنتاج ، فإنه يحتمل أن تكون هناك مشاكل في كل نتيجة للترجمة ، ويُنصح باستخدام الفروع للاختبار ومحاولة عدة مرات. +> نظرًا لأن `gpt3.5` هو نموذج AI الجيل الإنشائي، فإن كل نتيجة ترجمة لها احتمالية لظهور مشكلة، نوصي باستخدام اختبار الفروع وتجربة عدة مرات. > [!WARNING] -> إذا واجهت الخطأ التالي: `Error: Input required and not supplied: token`، يُرجى التأكد من إنشاء `Token` وفقًا للخطوة الثانية ، أو التحقق مما إذا كان الـ `Token` قد انتهت صلاحيته! +> إذا واجهتك الخطأ التالي: `Error: Input required and not supplied: token`، يرجى التأكد من أنك قمت بإنشاء `Token` وفقًا للخطوة الثانية، أو تحقق من انتهاء صلاحية `Token`! -1. انقر على رمز النجمة :star: لإضافة هذا المشروع إلى مستودع Github الخاص بك. + +1. انقر على :star: لإضافة هذا المشروع إلى مستودع Github الخاص بك. 2. قم بتعيين `Github Token` الخاص بك: * [أنشئ **`Github Secret Token`** جديد](https://github.com/settings/tokens/new) - * قم بإعداده + * قم بالإعداد * إعدادات المطور * رمز الوصول الشخصي - `Tokens(classic)` - * إنشاء رمز جديد - * اختيار **دورة حياة الرمز** - يُوصى باستخدام **غير محددة المدة** - * اختيار النطاق: `repo` و `workflow` - * **احتفظ** برمز الوصول السري الخاص بك (لا تفقده ، ستحتاج إليه في المستقبل) - + * إنشاء رمز وصول جديد + * اختر **دورة حياة الرمز** - من المستحسن استخدام **دائم** + * اختر النطاق: `repo` و `workflow` + * **احتفظ** برمزك السري (لا تفقده، ستحتاج إليه في المستقبل) + - * أنشئ **`repository secret`** جديدًا + * أنشئ **`repository secret`** جديد * في مستودعك - `settings` * `Securits and variables` * `Actions` * `New repository secret` - * قم بتعبئة علامة `token` وتسميتها (على سبيل المثال: `Action_Bot`) + * أدخل تسمية `token` واسم (مثال: `Action_Bot`) -3. قم بإنشاء مثال الإجراء الخاص بك في الدليل `.github/workflows/your_action.yml`. يمكنك نسخه مباشرة كما يلي: +3. قم بإنشاء مثال لعملك في المجلد `.github/workflows/your_action.yml`. ، يمكنك نسخ الآتي مباشرة: ``` # .github/workflows/translate.yml @@ -82,33 +84,12 @@ uses: Lin-jun-xiang/action-translate-readme@v2 # Based on the tag with: token: ${{ secrets.Action_Bot }} # Based on step2 name - g4f_provider: g4f.Provider.DeepAi # You can change this provider langs: "en,zh-TW,zh-CN,French,Arabic" # You can define any langs ``` - هناك ثلاثة معلمات تحتاج إلى إيلاء اهتمام خاص في الملف `.yml`: + هناك ثلاثة معلمات تحتاج إلى الانتباه إليها في `.yml`: - * `token`: الرمز الذي تم إنشاؤه في الخطوة 2 في المستودع - * `g4f_provider`: مزود gpt ، يُرجى الرجوع إلى المزيد من التفاصيل في ال[رابط](https://github.com/xtekky/gpt4free/tree/main#gpt-35--gpt-4) - * `langs`: الإصدارات التي تريد إنشاءها ، يجب عليك تحديد اللغات المختلفة بفاصلة `,` ، على سبيل المثال: + * `token`: استنادًا إلى الخطوة 2، رمز الوصول الذي تم إنشاؤه في مستودعك + * `langs`: الإصدارات التي ترغب في إنشائها بلغات مختلفة، تأكد من استخدام `,` لفصل اللغات المختلفة، على سبيل المثال: * `"en"`: ترجمة الإصدار الإنجليزي فقط - * `"en,zh-TW"`: ترجمة الإصدار الإنجليزي والإصدار التايواني التقليدي - * `"French,Arabic"`: ترجمة الإصدار الفرنسي والإصدار العربي - -4. يمكنك الآن تحديث `README.md` وسيتم إنشاء إصدار مترجم تلقائيًا! - ---- - -# عرض توضيحي - -![](./img/auto-translation.gif) - ---- - -# نتائج وثيقة الاختبار - -* شاهد [وثيقة الاختبار](https://github.com/Lin-jun-xiang/vscode-extensions-best/tree/main) -* استخدم أداةنا لتحديث وثيقة الاختبار - -العودة إلى الأعلى --------------------------------- \ No newline at end of file + * `"en,zh-TW"`: ترج \ No newline at end of file diff --git a/README.French.md b/README.French.md index cc28370..5b5c671 100644 --- a/README.French.md +++ b/README.French.md @@ -1,113 +1 @@ -# action-translate-readme - -

- -

- -* [English](README.md) -* [繁體中文版README.md](README.zh-TW.md) -* [简体中文](README.zh-CN.md) -* [Française](README.French.md) -* [عربى](README.Arabic.md) - - -# Introduction - -> [!NOTE] -> La version `v1` du traducteur est implémentée à l'aide d'un package tiers `Linux`; la version `v2` est mise en œuvre en appelant gratuitement l'API openai à l'aide de [`g4f`](https://github.com/xtekky/gpt4free). - - -* Nous savons tous que rédiger une documentation README prend beaucoup de temps, mais il existe maintenant une solution qui vous permet d'économiser la moitié de votre temps. C'est notre `action-translate-readme`. - -* Traduisez différentes versions de README dans différentes langues en utilisant `gpt3.5`. - -* Soumettez automatiquement (commit, push) les fichiers traduits à l'aide de **Github Actions (CI/CD)**. - -* Par exemple: **Écrivez** ou **modifiez** la version anglaise de README, et les versions en chinois traditionnel, en chinois simplifié, en français, etc., seront générées automatiquement. - - -# Comment utiliser ? - -> [!IMPORTANT] -> Comme `gpt3.5` est un modèle d'IA génératif, il y a une probabilité que chaque résultat de traduction présente des problèmes. Il est recommandé de tester sur une branche et d'essayer plusieurs fois. - -> [!WARNING] -> Si vous rencontrez l'erreur suivante : `Error: Input required and not supplied: token`, veuillez suivre l'étape 2 pour vérifier si vous avez créé le `Token` ou si le `Token` est expiré ! - -1. Cliquez sur l'icône :star: pour ajouter ce projet à votre dépôt Github. - -2. Configurez votre `Github Token` : - - * [Créez un nouveau **`Github Secret Token`**](https://github.com/settings/tokens/new) - * Réglages - * Réglages développeur - * Jetons d'accès personnels - `Tokens(classic)` - * Générer un nouveau jeton - * Choisissez la **durée de vie** du jeton - il est recommandé d'utiliser **illimité** - * Choisissez les autorisations : `repo` et `workflow` - * **Conservez** votre secret token (ne le perdez pas, vous en aurez besoin plus tard) - - - - * Créez un nouveau **`repository secret`** - * Dans votre dépôt - Paramètres - * Sécurité et variables - * Actions - * Nouveau secret de dépôt - * Étiquetez et nommez le secret (par ex : `Action_Bot`) - - - -3. Créez votre exemple d'action dans le répertoire `.github/workflows/your_action.yml`. Vous pouvez simplement copier le contenu suivant : - - ``` - # .github/workflows/translate.yml - name: Translate Readme - - on: - push: - branches: ['**'] - - jobs: - translate: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 3 - - - name: Auto Translate - uses: Lin-jun-xiang/action-translate-readme@v2 # Basé sur le tag - with: - token: ${{ secrets.Action_Bot }} # Basé sur le nom de l'étape 2 - g4f_provider: g4f.Provider.DeepAi # Vous pouvez changer ce fournisseur - langs: "en,zh-TW,zh-CN,French,Arabic" # Vous pouvez définir n'importe quelles langues - ``` - - Il y a trois paramètres dans le `.yml` à noter : - - * `token` : le token créé dans l'étape 2 dans le repo - * `g4f_provider` : le fournisseur de gpt, pour en savoir plus, veuillez consulter le [lien](https://github.com/xtekky/gpt4free/tree/main#gpt-35--gpt-4) - * `langs` : les versions linguistiques que vous souhaitez générer, veillez à séparer les différentes langues par des virgules, par exemple : - * `"en"` : traduire uniquement la version anglaise - * `"en,zh-TW"` : traduire l'anglais et le chinois traditionnel - * `"French,Arabic"` : traduire le français et l'arabe - -4. Maintenant, vous pouvez mettre à jour `README.md`, et une version traduite sera générée automatiquement ! - ---- - -# Démo - -![](./img/auto-translation.gif) - ---- - -# Résultats du document de test - -* Voir [le document de test](https://github.com/Lin-jun-xiang/vscode-extensions-best/tree/main) -* Mettez à jour le document de test avec notre outil - -Retour en haut --------------------------------- \ No newline at end of file +当前地区当日额度已消耗完, 请尝试更换网络环境 \ No newline at end of file diff --git a/README.md b/README.md index dd4ec8a..15ce264 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

* [English](README.md) -* [Traditional Chinese Version README.md](README.zh-TW.md) +* [Traditional Chinese README.md](README.zh-TW.md) * [Simplified Chinese](README.zh-CN.md) * [French](README.French.md) * [Arabic](README.Arabic.md) @@ -14,28 +14,28 @@ # Introduction > [!NOTE] -> The translator of version `v1` is implemented through a third-party package on `Linux`; version `v2` is implemented by calling the OpenAI API for free through [`g4f`](https://github.com/xtekky/gpt4free). +> The `v1` version translator is implemented through a third-party package on `Linux`; the `v2` version is implemented by calling the openai api for free through [`g4f`](https://github.com/xtekky/gpt4free). -* We all know that writing README documentation takes a lot of time, but now there is a solution that can save you half the time. This is our `action-translate-readme`. +* We all know that writing README documentation takes a lot of time, but now there is a solution that can save you half the time. That's our `action-translate-readme`. * Translate different language versions of README using `gpt3.5`. -* Automatically commit (commit, push) the translated files through **Github Actions (CI/CD)**. +* Automatically submit (commit, push) translated files through **Github Actions (CI/CD)**. -* For example: **Write** or **modify** the English version of README, and automatically generate versions of README in Traditional Chinese, Simplified Chinese, French, etc. +* For example: **Write** or **modify** the English version README, automatically generate Traditional Chinese, Simplified Chinese, French, etc., versions of README. # How to use? > [!IMPORTANT] -> Since `gpt3.5` is a generative AI model, there is a chance of problems with the translation results each time. It is recommended to use branch testing and try several times. +> Since `gpt3.5` belongs to a generative AI model, there is a probability of problems in each translation result. It is recommended to use branch testing and try several times. > [!WARNING] -> If you encounter the following error: `Error: Input required and not supplied: token`, please follow step two to ensure that the `Token` has been created or whether the `Token` has expired! +> If you encounter the following error: `Error: Input required and not supplied: token`, please follow step two to ensure that `Token` has been created, or whether `Token` has expired! -1. Click on the :star: icon to add this project to your Github repository. +1. Click the :star: icon to add this project to your Github repository. 2. Set up your `Github Token`: @@ -44,11 +44,11 @@ * Developer settings * Personal access tokens - `Tokens (classic)` * Generate new token - * Choose token **lifespan** - it is recommended to use **unlimited** + * Choose token **lifetime** - it is recommended to use **no expiration** * Choose scopes: `repo` and `workflow` - * **Keep** your secret token (do not lose it, you will need to paste it later) + * **Keep** your secret token (don't lose it, you'll need to paste it later) - + * Create a new **`repository secret`** * In your repository - `settings` @@ -57,9 +57,9 @@ * `New repository secret` * Fill in the label with `token` and name it (eg: `Action_Bot`) - + -3. Create an example of your action in the directory `.github/workflows/your_action.yml`. You can directly copy the following: +3. Create your action example in the directory `.github/workflows/your_action.yml`. You can directly copy the following: ``` # .github/workflows/translate.yml @@ -82,14 +82,12 @@ uses: Lin-jun-xiang/action-translate-readme@v2 # Based on the tag with: token: ${{ secrets.Action_Bot }} # Based on step2 name - g4f_provider: g4f.Provider.DeepAi # You can change this provider langs: "en,zh-TW,zh-CN,French,Arabic" # You can define any langs ``` - There are three parameters in `.yml` that need special attention: + There are three parameters to note in `.yml`: - * `token`: The token created in the repos based on step 2. - * `g4f_provider`: The provider of gpt, for more information, please refer to the [link](https://github.com/xtekky/gpt4free/tree/main#gpt-35--gpt-4) + * `token`: The token created in the repos according to step 2 * `langs`: The language versions you want to generate, be sure to separate different languages with `,`, for example: * `"en"`: Translate only the English version * `"en,zh-TW"`: Translate English and Traditional Chinese @@ -110,4 +108,5 @@ * View the [test document](https://github.com/Lin-jun-xiang/vscode-extensions-best/tree/main) * Use our tool to update the test document -Back to top \ No newline at end of file +Back to top +-------------------------------- \ No newline at end of file diff --git a/README.zh-CN.md b/README.zh-CN.md index 3680dee..5b5c671 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,112 +1 @@ -# action-translate-readme - -

- -

- -* [English](README.md) -* [繁體中文版README.md](README.zh-TW.md) -* [简体中文](README.zh-CN.md) -* [Française](README.French.md) -* [عربى](README.Arabic.md) - - -# 介绍 - -> [!NOTE] -> `v1`版本的翻译器是通过 `Linux` 第三方套件实现；`v2`版本是通过 [`g4f`](https://github.com/xtekky/gpt4free) 免费调用 openai api 实现翻译 - - -* 我们都知道写README文档很费时间,但是现在有一个解决方案可以让你节省一半的时间。这就是我们的`action-translate-readme` - -* 通过 `gpt3.5` 翻译不同语言版本的 README - -* 通过 **Github Actions(CI/CD) 自动提交(commit、push)** 翻译后的文件 - -* 例如：**撰写**或**修改**英文版README，自动生成繁體中文、简体中文、法文...等版本 README - - -# 如何使用？ - -> [!IMPORTANT] -> 由于 `gpt3.5` 属于生成式 AI 模型，因此每次翻译结果都有机率出现问题，建议使用分支测试，并多尝试几次。 - -> [!WARNING] -> 如果你遇到如下错误: `Error: Input required and not supplied: token`，请根据步骤二确定已建立 `Token`，或者 `Token` 是否已经过期！ - -1. 点击 :star: 图标将此项目添加到您的 Github 存储库. - -2. 设置你的 `Github Token`: - - * [创建一个新的 **`Github Secret Token`**](https://github.com/settings/tokens/new) - * 设置 - * 开发者设置 - * 个人访问令牌 - `Tokens(classic)` - * 生成新令牌 - * 选择令牌**生命周期** - 建议直接使用**无限期** - * 选择范围:`repo` 和 `workflow` - * **保留**你的secret token(不要丢了,以后需要贴上) - - - - * 创建一个新的 **`repository secret`** - * 在您的存储库中 - `settings` - * `Securits and variables` - * `Actions` - * `New repository secret` - * 按`token`填写标签并命名(eg: `Action_Bot`) - - - -3. 在目录 `.github/workflows/your_action.yml`. 中创建您的操作示例，你可以直接复制以下: - - ``` - # .github/workflows/translate.yml - name: Translate Readme - - on: - push: - branches: ['**'] - - jobs: - translate: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 3 - - - name: Auto Translate - uses: Lin-jun-xiang/action-translate-readme@v2 # Based on the tag - with: - token: ${{ secrets.Action_Bot }} # Based on step2 name - g4f_provider: g4f.Provider.DeepAi # You can change this provider - langs: "en,zh-TW,zh-CN,French,Arabic" # You can define any langs - ``` - - 在`.yml`中有三个参数要特别注意: - - * `token`: 根据步骤2，在repos中建立的token - * `g4f_provider`: gpt 的提供者，更多请参考[链接](https://github.com/xtekky/gpt4free/tree/main#gpt-35--gpt-4) - * `langs`: 想要产生的语言版本，务必用`,`分隔不同语言，例如: - * `"en"`: 仅翻译英文版 - * `"en,zh-TW"`: 翻译英文、繁體中文 - * `"French,Arabic"`: 翻译法文、阿拉伯文 - -4. 现在你可以更新 `README.md`,它会自动生成一个翻译版本！ - ---- - -# 演示 - -![](./img/auto-translation.gif) - ---- - -#测试文档结果 - -* 查看[测试文档](https://github.com/Lin-jun-xiang/vscode-extensions-best/tree/main) -* 使用我们的工具更新测试文档 - -返回顶部