AI を活用した README の翻訳を、簡単に。
以下のツールと技術で構築:
readmeaiauto は、Google の AI を使用して README ファイルを複数の言語に簡単に翻訳します。これにより、開発者の国際化が簡素化され、グローバルなリーチとアクセシビリティが確保されます。主な機能には、自動翻訳、フォーマットの保持、構成可能な言語サポートなどがあります。オープンソースプロジェクトや多言語チームに最適です。
| 機能 | 概要 | |
|---|---|---|
| ⚙️ | アーキテクチャ |
|
| 🔩 | コード品質 |
|
| 📄 | ドキュメント |
|
| 🔌 | 統合 |
|
| 🧩 | モジュール性 |
|
| 🧪 | テスト |
|
| ⚡️ | パフォーマンス |
|
└── readmeai_auto/
├── LICENSE
├── README.md
├── README_DE.md
├── README_EN.md
├── README_ES.md
├── README_FR.md
├── README_JA.md
├── README_KO.md
├── README_RU.md
├── README_ZH.md
├── readme_translator.py
└── requirements.txtREADMEAI_AUTO/
__root__
requirements.txt - `requirements.txt` ファイルは、プロジェクトの外部依存関係を指定します。
- プロジェクトが Google Generative AI API にアクセスし、`python-dotenv` によって管理される環境変数を活用できることを保証します。
- これにより、Google の AI サービスとの統合が容易になり、アプリケーションがその機能を活用できるようになります。readme_translator.py - `readme_translator.py` スクリプトは、README ファイルの翻訳を自動化します。
- Google Gemini API を活用して、ソース README を複数の言語に翻訳し、フォーマットと技術的な正確性を保持します。
- スクリプトには、入力ファイルとターゲット言語を指定するためのコマンドラインオプションがあり、進行状況とエラーをログに記録します。
- サポートされている言語は構成可能で、国際化の柔軟性が向上します。
readmeai_auto を始める前に、実行時環境が次の要件を満たしていることを確認してください。
- プログラミング言語: 主要言語のエラー検出: {'txt': 1, 'py': 1}
- パッケージマネージャー: Pip
次のいずれかの方法を使用して readmeai_auto をインストールします。
ソースからビルド:
- readmeai_auto リポジトリをクローンします。
❯ git clone ../readmeai_auto- プロジェクトディレクトリに移動します。
❯ cd readmeai_auto- プロジェクトの依存関係をインストールします。
pip を使用
❯ echo 'INSERT-INSTALL-COMMAND-HERE'次のコマンドを使用して readmeai_auto を実行します。
pip を使用
❯ echo 'INSERT-RUN-COMMAND-HERE'--folder パラメータを使用して、翻訳対象のフォルダを指定できます。
❯ python readme_translator.py --folder <フォルダパス>--exclude パラメータを使用して、翻訳から除外するファイルまたはフォルダを指定できます。
❯ python readme_translator.py --exclude <ファイル/フォルダパス>次のコマンドを使用してテストスイートを実行します。
pip を使用
❯ echo 'INSERT-TEST-COMMAND-HERE'-
タスク 1:機能 1 を実装します。 -
タスク 2: 機能 2 を実装します。 -
タスク 3: 機能 3 を実装します。
- 💬 ディスカッションに参加する: あなたの洞察を共有したり、フィードバックを提供したり、質問をしたりしてください。
- 🐛 問題を報告する:
readmeai_autoプロジェクトのバグを送信するか、機能リクエストをログに記録してください。 - 💡 プルリクエストを送信する: オープンな PR を確認し、独自の PR を送信してください。
貢献ガイドライン
- リポジトリをフォークする: まず、プロジェクトリポジトリを LOCAL アカウントにフォークします。
- ローカルにクローンする: git クライアントを使用して、フォークしたリポジトリをローカルマシンにクローンします。
git clone /home/jinno/git/readmeai_auto_action/readmeai_auto/
- 新しいブランチを作成する: 常に新しいブランチで作業し、わかりやすい名前を付けます。
git checkout -b new-feature-x
- 変更を加える: 変更をローカルで開発およびテストします。
- 変更をコミットする: 更新内容を説明する明確なメッセージでコミットします。
git commit -m '新機能 x を実装しました。' - LOCAL にプッシュする: 変更をフォークしたリポジトリにプッシュします。
git push origin new-feature-x
- プルリクエストを送信する: 元のプロジェクトリポジトリに対して PR を作成します。変更とその動機を明確に説明してください。
- レビュー: PR がレビューされ承認されると、メインブランチにマージされます。貢献おめでとうございます！
貢献者グラフ
このプロジェクトは、SELECT-A-LICENSE ライセンスの下で保護されています。詳細については、LICENSE ファイルを参照してください。
- ここに、リソース、貢献者、インスピレーションなどをリストしてください。