From 6f5b65bf522d26d7dcdf61fa4ea3b09d1cb9ac84 Mon Sep 17 00:00:00 2001 From: xu Date: Thu, 30 May 2024 19:12:13 +0800 Subject: [PATCH] =?UTF-8?q?=E3=80=90=E7=B1=BB=09=E5=9E=8B=E3=80=91?= =?UTF-8?q?=EF=BC=9Adocs=20=E3=80=90=E4=B8=BB=09=E9=A2=98=E3=80=91?= =?UTF-8?q?=EF=BC=9A=E6=A0=B9=E6=8D=AE=E5=85=AC=E5=8F=B8=E6=83=85=E5=86=B5?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=A8=A1=E6=9D=BF=20=E3=80=90=E6=8F=8F=09?= =?UTF-8?q?=E8=BF=B0=E3=80=91=EF=BC=9A=20=09[=E5=8E=9F=E5=9B=A0]=EF=BC=9A?= =?UTF-8?q?=20=09[=E8=BF=87=E7=A8=8B]=EF=BC=9A=20=09[=E5=BD=B1=E5=93=8D]?= =?UTF-8?q?=EF=BC=9A=20=E3=80=90=E7=BB=93=09=E6=9D=9F=E3=80=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # 类型 包含: # feat：新功能（feature） # fix：修补bug # docs：文档（documentation） # style： 格式（不影响代码运行的变动） # refactor：重构（即不是新增功能，也不是修改bug的代码变动） # test：增加测试 # chore：构建过程或辅助工具的变动 --- git相关/项目说明模板/README.md | 97 ++++++++++------------------------ 1 file changed, 27 insertions(+), 70 deletions(-) diff --git a/git相关/项目说明模板/README.md b/git相关/项目说明模板/README.md index 210ba78..2dab98f 100644 --- a/git相关/项目说明模板/README.md +++ b/git相关/项目说明模板/README.md @@ -10,8 +10,7 @@ ProjectName and Description [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] -[![MIT License][license-shield]][license-url] -[![LinkedIn][linkedin-shield]][linkedin-url] +
@@ -20,10 +19,9 @@ ProjectName and Description Logo - -

"完美的"README模板

+

飞行魔方README模板

- 一个"完美的"README模板去快速开始你的项目！ + 一个README模板去快速开始你的项目！
探索本项目的文档 »
@@ -39,21 +37,39 @@ ProjectName and Description 本篇README.md面向开发者 - + ## 目录 +- [项目说明](#项目说明) + - [上手指南](#上手指南) + - [开发前的配置要求](#开发前的配置要求) - [安装步骤](#安装步骤) + - [文件目录说明](#文件目录说明) + - [开发的架构](#开发的架构) + - [部署](#部署) + - [使用到的框架](#使用到的框架) -- [贡献者](#贡献者) - - [如何参与开源项目](#如何参与开源项目) -- [版本控制](#版本控制) -- [作者](#作者) -- [鸣谢](#鸣谢) + + + +### 项目说明 + +###### 主要功能： + +1. xxxxx x.x.x +2. xxxxx x.x.x + +###### 物理连接： + +1. xxxxx x.x.x +2. xxxxx x.x.x + + ### 上手指南 @@ -116,64 +132,5 @@ filetree - [xxxxxxx](https://jquery.com) - [xxxxxxx](https://laravel.com) -### 贡献者 - -请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。 - -#### 如何参与开源项目 - -贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。 - - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - - - -### 版本控制 - -该项目使用Git进行版本管理。您可以在repository参看当前可用版本。 - -### 作者 - -xxx@xxxx - -知乎:xxxx   qq:xxxxxx - - *您也可以在贡献者名单中参看所有参与该项目的开发者。* - -### 版权说明 - -该项目签署了MIT 授权许可，详情请参阅 [LICENSE.txt](https://github.com/shaojintian/Best_README_template/blob/master/LICENSE.txt) - -### 鸣谢 - - -- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) -- [Img Shields](https://shields.io) -- [Choose an Open Source License](https://choosealicense.com) -- [GitHub Pages](https://pages.github.com) -- [Animate.css](https://daneden.github.io/animate.css) -- [xxxxxxxxxxxxxx](https://connoratherton.com/loaders) - - -[your-project-path]:shaojintian/Best_README_template -[contributors-shield]: https://img.shields.io/github/contributors/shaojintian/Best_README_template.svg?style=flat-square -[contributors-url]: https://github.com/shaojintian/Best_README_template/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/shaojintian/Best_README_template.svg?style=flat-square -[forks-url]: https://github.com/shaojintian/Best_README_template/network/members -[stars-shield]: https://img.shields.io/github/stars/shaojintian/Best_README_template.svg?style=flat-square -[stars-url]: https://github.com/shaojintian/Best_README_template/stargazers -[issues-shield]: https://img.shields.io/github/issues/shaojintian/Best_README_template.svg?style=flat-square -[issues-url]: https://img.shields.io/github/issues/shaojintian/Best_README_template.svg -[license-shield]: https://img.shields.io/github/license/shaojintian/Best_README_template.svg?style=flat-square -[license-url]: https://github.com/shaojintian/Best_README_template/blob/master/LICENSE.txt -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 -[linkedin-url]: https://linkedin.com/in/shaojintian - -