Skip to content

Commit

Permalink
Merge pull request #16 from Sunwood-ai-labs/translate-readme-11418758213
Browse files Browse the repository at this point in the history
📖 [docs] 英語READMEの自動更新
  • Loading branch information
iris-s-coon authored Oct 19, 2024
2 parents e7e86c5 + c57f96b commit b5bf477
Showing 1 changed file with 27 additions and 26 deletions.
53 changes: 27 additions & 26 deletions docs/README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,46 +49,47 @@ license: mit
<a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/docs/README.en.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
</h2>
<p align="center">
<img src="https://img.shields.io/badge/Python-3.8%2B-blue?logo=python&logoColor=white" alt="Python 3.8+">
<img src="https://img.shields.io/badge/OpenAI-GPT--4-blue?logo=openai&logoColor=white" alt="OpenAI GPT-4">
<img src="https://img.shields.io/badge/Google-Gemini-blue?logo=google&logoColor=white" alt="Google Gemini">
<img src="https://img.shields.io/badge/Git-Version%20Control-blue?logo=git&logoColor=white" alt="Git">
<img src="https://img.shields.io/badge/GitHub-Repository-blue?logo=github&logoColor=white" alt="GitHub">
<img src="https://img.shields.io/badge/GitHub%20Actions-CI%2FCD-blue?logo=github-actions&logoColor=white" alt="GitHub Actions">
<img src="https://img.shields.io/badge/YAML-Configuration-blue?logo=yaml&logoColor=white" alt="YAML">
<img src="https://img.shields.io/badge/pip-Dependency%20Management-blue?logo=pypi&logoColor=white" alt="pip">
<img src="https://img.shields.io/badge/Markdown-Documentation-blue?logo=markdown&logoColor=white" alt="Markdown">
<img src="https://img.shields.io/badge/GitHub%20API-Integration-blue?logo=github&logoColor=white" alt="GitHub API">
<img src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python" alt="Python">
<img src="https://img.shields.io/badge/OpenAI-412991?style=for-the-badge&logo=openai" alt="OpenAI">
<img src="https://img.shields.io/badge/Gemini-8E75B2?style=for-the-badge&logo=google" alt="Google Gemini">
<img src="https://img.shields.io/badge/Git-F05032?style=for-the-badge&logo=git" alt="Git">
<img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github" alt="GitHub">
<img src="https://img.shields.io/badge/Actions-2088FF?style=for-the-badge&logo=github-actions" alt="GitHub Actions">
<img src="https://img.shields.io/badge/YAML-CB171E?style=for-the-badge&logo=yaml" alt="YAML">
<img src="https://img.shields.io/badge/pip-3775A9?style=for-the-badge&logo=pypi" alt="pip">
<img src="https://img.shields.io/badge/Markdown-000000?style=for-the-badge&logo=markdown" alt="Markdown">
<img src="https://img.shields.io/badge/GitHub_API-181717?style=for-the-badge&logo=github" alt="GitHub API">
</p>
<p align="center">
<a href="https://github.com/Sunwood-ai-labs/AIRA">
<img src="https://img.shields.io/badge/AIRA-Auto%20Commit-orange?style=for-the-badge&logo=github" alt="AIRA">
<img src="https://img.shields.io/badge/AIRA-FF4500?style=for-the-badge&logo=github" alt="AIRA">
</a>
<a href="https://github.com/Sunwood-ai-labs/IRIS">
<img src="https://img.shields.io/badge/IRIS-Auto%20Repo%20Management-purple?style=for-the-badge&logo=github" alt="IRIS">
<img src="https://img.shields.io/badge/IRIS-9370DB?style=for-the-badge&logo=github" alt="IRIS">
</a>
</p>


> [!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 the release notes, README, and commit messages were generated using the latest AI technology.
> 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 were generated using the latest AI technologies.
## 🚀 Project Overview

HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and IRIS. This repository aims to dramatically improve developer efficiency by providing the structure and workflow for AI development projects leveraging LLMs. Version: `v1.2.0`
HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and IRIS. This repository aims to dramatically improve developer efficiency by providing the structure and workflow for AI development projects utilizing LLMs. Version: `v1.2.0`


## 🆕 Latest News

- 🎉 v1.2.0 release: Added GitHub Shields to the README, added collaborator invitation functionality, and updated documentation.


## Key Features
## Main Features

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 automated README translation.
5. **Flexible Customization**: Easily adjustable to meet the needs of your project.
5. **Flexible Customization**: Easily adjustable to suit the needs of your project.
6. **Automated Collaborator Invitation**: Collaborator invitation script using the GitHub API.


Expand Down Expand Up @@ -125,7 +126,7 @@ Follow these steps to set up the HarmonAI III environment:
```bash
python3 -m venv .venv
```
This will create a virtual environment in the `.venv` directory.
This creates a virtual environment in the `.venv` directory.

2. Activate the virtual environment:
```bash
Expand All @@ -149,7 +150,7 @@ These steps will prepare the development environment for HarmonAI III.

### 🌈 [IRIS (Intelligent Repository Issue Solver)](https://github.com/Sunwood-ai-labs/IRIS)
- Automated issue classification
- Automated solution suggestions
- Automated solution suggestion
- Automated release note generation
- Automated README translation

Expand Down Expand Up @@ -180,12 +181,12 @@ 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 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 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, update the token regularly 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. It allows you to efficiently expand your team while maintaining security.
This feature simplifies the process of adding new contributors to the project. You can efficiently expand your team while maintaining security.
## 🐈 Processing Flow
Expand All @@ -198,7 +199,7 @@ graph LR
B -->|Human Action| C[HarmonAI III Repository Initialization]
C -->|Automated| D[Development Work]
D -->|Human Action| E[AIRA Automated Commits]
E --> H[IRIS Release Note Generation]
E --> H[IRIS Release Note Creation]
H --> I[IRIS Documentation Translation]
I --> J[Release]
J --> K[End]
Expand All @@ -223,8 +224,8 @@ HarmonAI III is released under the [MIT License](LICENSE).
## 🙏 Acknowledgements
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.
In developing HarmonAI III, we have drawn inspiration from many open-source projects. We especially thank the developers of AIRA and IRIS. Thanks also to iris-s-coon and Maki.
---
HarmonAI III is an excellent starter kit for realizing an AI-driven development process. Start developing innovative AI projects based on this template!
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!

0 comments on commit b5bf477

Please sign in to comment.