diff --git a/README.md b/README.md index ff1b487..617f93a 100644 --- a/README.md +++ b/README.md @@ -49,26 +49,27 @@ license: mit EN doc

- Python 3.8+ - OpenAI GPT-4 - Google Gemini - Git - GitHub - GitHub Actions - YAML - pip - Markdown - GitHub API + Python + OpenAI + Google Gemini + Git + GitHub + GitHub Actions + YAML + pip + Markdown + GitHub API

- AIRA + AIRA - IRIS + IRIS

+ > [!IMPORTANT] > HarmonAI IIIは、[cline (旧:Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), [claude.ai](https://claude.ai/)を活用して開発されたテンプレートリポジトリです。リリースノート、README、コミットメッセージの大部分は、最新のAI技術を用いて生成されています。 diff --git a/docs/README.en.md b/docs/README.en.md index 81a6b89..9f6a55e 100644 --- a/docs/README.en.md +++ b/docs/README.en.md @@ -1,8 +1,19 @@ +--- +title: HarmonAI III +emoji: 🦀 +colorFrom: green +colorTo: blue +sdk: streamlit +sdk_version: 1.39.0 +app_file: app.py +pinned: false +license: mit +--- +

🌟 HarmonAI III 🌟

-

GitHub Repo @@ -16,17 +27,12 @@ GitHub release - - GitHub commit activity + + GitHub issues PRs Welcome - GitHub repo size - Development Status - - GitHub issues - GitHub forks @@ -35,57 +41,36 @@ GitHub last commit GitHub top language - - GitHub contributors - - - GitHub closed issues - - - GitHub closed PRs - - GitHub language count - GitHub search hit counter - GitHub code size - - Contributor Covenant - - - Twitter - - GitHub Created At - - GitHub deployments - - - GitHub Discussions - - GitHub followers - GitHub Release Date - GitHub commit activity (branch) - GitHub commits since latest release (by date) - - - -

- -

- - GitHub Workflow Status - - GitHub Workflow Status - - GitHub Workflow Status

~ AI-Powered Automated Repository Management Template ~ - JA doc - EN doc +JA doc +EN doc

+

+ Python 3.8+ + OpenAI GPT-4 + Google Gemini + Git + GitHub + GitHub Actions + YAML + pip + Markdown + GitHub API +

+

+ + AIRA + + + IRIS + +

> [!IMPORTANT] -> HarmonAI III is a template repository developed using [cline (formerly Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and [claude.ai](https://claude.ai/). The majority of release notes, README, and commit messages are generated using the latest AI technologies. +> HarmonAI III is a template repository developed using [cline (formerly Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and [claude.ai](https://claude.ai/). The majority of the release notes, README, and commit messages were generated using the latest AI technology. ## 🚀 Project Overview @@ -94,7 +79,7 @@ HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and ## 🆕 Latest News -- 🎉 v1.2.0 released: Added GitHub Shields to the README, added collaborator invitation functionality, and updated documentation. +- 🎉 v1.2.0 release: Added GitHub Shields to the README, added collaborator invitation functionality, and updated documentation. ## ✨ Key Features @@ -102,8 +87,8 @@ HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and 1. **Integrated AI Toolset**: Provides the functionality of AIRA and IRIS in a single package. 2. **Ready to Use**: Easily create a repository with a high-quality initial structure by using it as a template. 3. **Automated Development Workflow**: Automates commit message generation, release note creation, and issue management. -4. **Multilingual Support**: Supports international project deployment through automatic README translation. -5. **Flexible Customization**: Easily adaptable to the needs of your project. +4. **Multilingual Support**: Supports international project deployment through automated README translation. +5. **Flexible Customization**: Easily adjustable to meet the needs of your project. 6. **Automated Collaborator Invitation**: Collaborator invitation script using the GitHub API. @@ -132,7 +117,7 @@ Refer to the documentation for each component for detailed usage instructions. 6. Open the `.github/release_notes/.sourcesage_releasenotes_iris.yml` file and change the value of `repo-name:` to your new repository name. -## 🌿 Setting up the Environment +## 🌿 Environment Setup Follow these steps to set up the HarmonAI III environment: @@ -140,7 +125,7 @@ Follow these steps to set up the HarmonAI III environment: ```bash python3 -m venv .venv ``` - This creates a virtual environment in the `.venv` directory. + This will create a virtual environment in the `.venv` directory. 2. Activate the virtual environment: ```bash @@ -153,7 +138,7 @@ Follow these steps to set up the HarmonAI III environment: pip install -r requirements.txt ``` -These steps will prepare your development environment for HarmonAI III. +These steps will prepare the development environment for HarmonAI III. ## 📚 Main Components @@ -170,14 +155,14 @@ These steps will prepare your development environment for HarmonAI III. ## 🤝 Automated Collaborator Invitation -HarmonAI III includes a script to automatically invite collaborators to the GitHub repository. Use it as follows: +HarmonAI III includes a script to automatically invite collaborators to the GitHub repository. It can be used as follows: 1. Create a `.env` file and set the necessary tokens: ``` # GitHub access token (for collaborator invitation) GITHUB_TOKEN=your_github_personal_access_token_here - # The following are examples of tokens that may be used by other functions. It's convenient to list them for later use. + # The following are examples of tokens that may be used by other functions. It's convenient to include them for later use. # GITHUB_ACCESS_TOKEN=ghp_xxxxx # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy # GEMINI_API_KEY=AIzzzzz @@ -185,7 +170,7 @@ HarmonAI III includes a script to automatically invite collaborators to the GitH Note: Include the `.env` file in `.gitignore` to prevent it from being committed to the repository. -2. Run the following command to invite a collaborator: +2. Run the following command to invite collaborators: ```bash python .github/github_add_collaborator.py Sunwood-ai-labs/HarmonAI_III username_to_invite ``` @@ -195,14 +180,14 @@ HarmonAI III includes a script to automatically invite collaborators to the GitH 3. Once the script runs successfully, a collaborator invitation will be sent to the specified user. Cautions: -- This script requires the GitHub token to have appropriate permissions (the `repo` scope). -- When using it for an organization's repository, ensure that appropriate permissions are granted in the organization's settings. -- For security reasons, update tokens regularly and grant only the minimum necessary permissions. -- Never commit information including the `.env` file or tokens to a public repository. +- This script requires the GitHub token to have the appropriate permissions (`repo` scope). +- When using it for an organization's repository, ensure that the appropriate permissions are granted in the organization's settings. +- For security, regularly update the token and grant only the minimum necessary permissions. +- Never commit information, including the `.env` file or tokens, to a public repository. -This feature simplifies the process of adding new contributors to the project. You can efficiently expand your team while maintaining security. +This feature simplifies the process of adding new contributors to the project. It allows you to efficiently expand your team while maintaining security. -## 🐈 Process Flow +## 🐈 Processing Flow ```mermaid @@ -230,16 +215,16 @@ graph LR ## 🤝 Contributions -HarmonAI III welcomes contributions from the community as an open-source project. Help improve this template repository through bug reports, feature requests, and pull requests. +HarmonAI III welcomes contributions from the community as an open-source project. Please help improve this template repository through bug reports, feature requests, and pull requests. ## 📄 License HarmonAI III is released under the [MIT License](LICENSE). -## 🙏 Acknowledgments +## 🙏 Acknowledgements -HarmonAI III has been inspired by many open-source projects. We especially thank the developers of AIRA and IRIS. We also thank iris-s-coon and Maki. +HarmonAI III has drawn inspiration from many open-source projects during its development. We especially thank the developers of AIRA and IRIS. We also thank iris-s-coon and Maki. --- -HarmonAI III is an excellent starter kit for achieving an AI-driven development process. Let's start developing innovative AI projects based on this template! \ No newline at end of file +HarmonAI III is an excellent starter kit for realizing an AI-driven development process. Start developing innovative AI projects based on this template! \ No newline at end of file