Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README_cn.md #8344

Merged
merged 20 commits into from
Jun 26, 2022
Merged

Create README_cn.md #8344

merged 20 commits into from
Jun 26, 2022

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jun 26, 2022

Add mandarin version of README. Translation by @KieraMengru0907

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Added Chinese README to the Ultralytics YOLOv5 repository.

πŸ“Š Key Changes

  • New Documentation: A Chinese version of the README (README_cn.md) has been added to the repository.
  • Pre-commit Config Update: The .pre-commit-config.yaml file has been updated to exclude both README.md and the new README_cn.md from certain checks.
  • Main README Reference: A direct reference to the new README_cn.md seems to be hinted at with additional blank spaces added to the main README.

🎯 Purpose & Impact

  • 🌐 Language Inclusivity: The addition of the Chinese README will make the project more accessible to Chinese-speaking users, potentially increasing the user base.
  • πŸ“ Documentation Clarity: Non-English speakers can better understand how to use YOLOv5 with documentation in their native language.
  • ✨ Enhanced Collaboration: Easier contribution and feedback from Chinese developers who may have been hindered by language barriers.
  • 🧹 Code Maintenance: Updating the pre-commit config will help maintain clean code by ensuring README files meet style requirements.

Add mandarin version of README
@glenn-jocher glenn-jocher self-assigned this Jun 26, 2022
@glenn-jocher glenn-jocher merged commit 5c990e3 into master Jun 26, 2022
@glenn-jocher glenn-jocher deleted the update/README_cn branch June 26, 2022 15:46
@glenn-jocher
Copy link
Member Author

@KieraMengru0907 PR is merged. Thank you for your contributions to YOLOv5 πŸš€ and Vision AI ⭐

ctjanuhowski pushed a commit to ctjanuhowski/yolov5 that referenced this pull request Sep 8, 2022
* Create README_cn.md

Add mandarin version of README

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

* fix link

* fix english link

* remove line

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README_cn.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README_cn.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update .pre-commit-config.yaml

* Update README.md

* Update README_cn.md

* Kiera fix

* Update README_cn.md

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant