From 11d3dc93b8fd579af352d9d19773dd63b0d4b08f Mon Sep 17 00:00:00 2001 From: iris-s-coon Date: Sun, 10 Nov 2024 14:08:42 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20[docs]=20=E8=8B=B1=E8=AA=9EREADM?= =?UTF-8?q?E=E3=81=AE=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.en.md | 134 +++++++++++++++++++++------------------------- 1 file changed, 61 insertions(+), 73 deletions(-) diff --git a/docs/README.en.md b/docs/README.en.md index a47e6531..60cb63b6 100644 --- a/docs/README.en.md +++ b/docs/README.en.md @@ -1,52 +1,40 @@ ---- -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 🌟

+ +

🌄 AMATERASU 🌄

- + GitHub Repo - - License + + License - - GitHub stars + + GitHub stars - - GitHub release + + GitHub release - - GitHub issues + + GitHub issues - + PRs Welcome - - GitHub forks + + GitHub forks - - GitHub watchers + + GitHub watchers - GitHub last commit - GitHub top language + GitHub last commit + GitHub top language

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

Python @@ -71,34 +59,34 @@ license: mit > [!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/). A large portion of the 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.3.0` +HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and IRIS. This repository aims to dramatically improve developer efficiency by providing a structure and workflow for AI development projects leveraging LLMs. Version: `v1.3.0` -## 🆕 Latest News +## 🆕 What's New -- 🎉 **v1.3.0 Released**: Created a basic Streamlit app structure, improved README file design, fixed several bugs, and updated the documentation. The Streamlit app now includes a feature to display the contents of the README.md file. Error handling for cases where the README.md file is missing has also been added. Furthermore, we've added a collaborator addition script for the GitHub repository, an automated synchronization workflow with Hugging Face Hub, and an automated deployment workflow to PyPI. +- 🎉 **v1.3.0 Release**: Added basic Streamlit app structure, improved README file design, fixed several bugs, and updated documentation. The Streamlit app now includes functionality to display the contents of the README.md file. Error handling for missing README.md files has also been added. Furthermore, scripts for adding collaborators to the GitHub repository, automated synchronization workflows with Hugging Face Hub, and automated deployment workflows to PyPI have been added. -## ✨ Main Features +## ✨ Key Features -1. **Integrated AI Toolset**: Provides the functionalities of AIRA and IRIS in a single package. +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 suit the needs of your project. -6. **Automated Collaborator Invitation**: Collaborator invitation script using the GitHub API. -7. **Streamlit App**: A basic Streamlit application that displays the README.md file. +5. **Flexible Customization**: Easily adjustable to suit project needs. +6. **Automated Collaborator Invitation**: Collaborator invitation script using the GitHub API. +7. **Streamlit App**: A basic Streamlit application to display the README.md file. ## 🔧 How to Use ### Running the Streamlit App -1. Install the necessary packages with `pip install -r requirements.txt`. -2. Run `streamlit run app.py`. +1. Install the necessary packages with: `pip install -r requirements.txt`. +2. Run: `streamlit run app.py`. ### AIRA Example: ```bash @@ -107,10 +95,10 @@ aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-n ### IRIS Example: -Refer to the documentation of each component for detailed usage instructions. +Refer to the documentation for each component for detailed usage instructions. -## 📦 Installation Instructions +## 📦 Installation 1. Use this repository as a template to create a new repository. 2. Clone the repository locally. @@ -119,13 +107,13 @@ Refer to the documentation of each component for detailed usage instructions. pip install -r requirements.txt ``` 4. Customize the AIRA and IRIS configuration files. -5. Check the GitHub Actions settings and configure environment variables as needed. +5. Review the GitHub Actions settings and configure environment variables as needed. 6. Open the `.github/release_notes/.sourcesage_releasenotes_iris.yml` file and change the value of `repo-name:` to your new repository name. -## 🌿 Environment Setup +## 🌿 Setting up the Environment -Follow these steps to set up the HarmonAI III environment: +To set up the HarmonAI III environment, follow these steps: 1. Create a virtual environment: ```bash @@ -139,36 +127,36 @@ Follow these steps to set up the HarmonAI III environment: .venv\Scripts\activate # Windows ``` -3. Install dependencies: +3. Install the dependencies: ```bash 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 ### 🤖 [AIRA (AI-Integrated Repository for Accelerated Development)](https://github.com/Sunwood-ai-labs/AIRA) -- Automated repository creation -- Automated commit message generation +- Automates repository creation. +- Automates commit message generation. ### 🌈 [IRIS (Intelligent Repository Issue Solver)](https://github.com/Sunwood-ai-labs/IRIS) -- Automated issue classification -- Automated solution suggestion -- Automated release note generation -- Automated README translation +- Automates issue classification. +- Automates solution suggestions. +- Automates release note generation. +- Automates README translation. ## 🤝 Automated Collaborator Invitation -HarmonAI III includes a script to automatically invite collaborators to the GitHub repository. Use it with the following steps: +HarmonAI III includes a script to automatically invite collaborators to the GitHub repository. You can use it with the following steps: 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 have them written down for later use. + # The following are examples of tokens that may be used for other features. It is convenient to list them for later use. # GITHUB_ACCESS_TOKEN=ghp_xxxxx # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy # GEMINI_API_KEY=AIzzzzz @@ -176,24 +164,24 @@ 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 collaborators: +2. Run the following command to invite a collaborator: ```bash - python .github/github_add_collaborator.py Sunwood-ai-labs/HarmonAI_III username_to_invite + python .github/github_add_collaborator.py Sunwood-ai-labs/AMATERASU username_to_invite ``` Replace `username_to_invite` with the GitHub username you want to invite. 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 appropriate permissions are granted in the organization's settings. -- For security, update tokens regularly and grant only the minimum necessary permissions. -- Never commit information, including the `.env` file and tokens, to a public repository. +Notes: +- This script requires the GitHub token to have appropriate permissions (the `repo` scope). +- When used 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 your project. You can efficiently expand your team while maintaining security. +This feature simplifies the process of adding new contributors to the project. It allows for efficient team expansion while maintaining security. -## 🐈 Processing Flow +## 🐈 Process Flow ```mermaid @@ -203,7 +191,7 @@ graph LR A[Start] --> B[Repository Conception and Naming] B -->|Human Action| C[HarmonAI III Repository Initialization] C -->|Automated| D[Development Work] - D -->|Human Action| E[AIRA Automated Commits] + D -->|Human Action| E[AIRA Commit Automation] E --> H[IRIS Release Note Creation] H --> I[IRIS Documentation Translation] I --> J[Release] @@ -219,18 +207,18 @@ graph LR -## 🤝 Contributions +## 🤝 Contributing -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. +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 licensed under the [MIT License](LICENSE). +HarmonAI III is released under the [MIT License](LICENSE). ## 🙏 Acknowledgements -HarmonAI III has drawn inspiration from many open-source projects during its development. We extend our deepest gratitude to the developers of AIRA and IRIS, in particular. 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. Start developing innovative AI projects based on this template! \ No newline at end of file +HarmonAI III is an excellent starter kit for realizing AI-driven development processes. Let's start developing innovative AI projects based on this template! \ No newline at end of file