diff --git a/BLANK_README.md b/BLANK_README.md index 6b9048de4..7a16c31a7 100644 --- a/BLANK_README.md +++ b/BLANK_README.md @@ -50,6 +50,35 @@

+ + diff --git a/README.md b/README.md index 62e0015e5..2357d3ccb 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,38 @@ · Request Feature

+ + + +

+ 简体中文 + +

+ diff --git a/docs/README_zh_cn.md b/docs/README_zh_cn.md new file mode 100644 index 000000000..1113dfe94 --- /dev/null +++ b/docs/README_zh_cn.md @@ -0,0 +1,281 @@ +
+ + + + + + +[![Contributors][contributors-shield]][contributors-url] +[![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] + + + + +
+
+ + Logo + + +

Best-README-Template-zh_CN

+ +

+ 让你快速开始构建项目的最佳 README 模板！ +
+ 浏览文档 » +
+
+ 查看 Demo + · + 反馈 Bug + · + 请求新功能 +

+
+ + + +

+ English + +

+ + + +
+ 目录 +
    +
  1. + 关于本项目 + +
    2. +
  2. + 开始 + +
    3. +
  3. 使用方法
    4. +
  4. 路线图
    5. +
  5. 贡献
    6. +
  6. 许可证
    7. +
  7. 联系我们
    8. +
  8. 致谢
    9. +
+
+ + + + +## 关于本项目 + +[![产品截图][product-screenshot]](https://example.com) + +GitHub 上有很多优秀的 README 模板，但我没找到一个适合我需求的，所以我创建了这个增强版。我想要创建一个 README 模板，它能优秀到成为你的最后一个 README 模板 —— 我认为这就是你所需要的。 + +以下是原因： +* 你应该把时间用在项目的「刀刃」上，也就是专注于解决问题本身上 +* 你不应该一遍又一遍地做重复的工作，比如每次都从头编写一个 README +* 你应该在未来的生活中始终遵循 DRY 原则 :smile: + +当然，没有一个模板可以满足所有项目，因为你的需求可能与众不同。所以我们会在未来添加更多内容。你也可以通过复刻（fork）本仓库并且创建一个拉取请求（pull request）或者创建议题（issue）来向我们提出建议。感谢所有帮助我们扩充本模板的贡献者！ + +使用 `BLANK_README_zh.md` 来开始。 + +

(返回顶部)

+ + + +### 构建工具 + +你应该在这里列出项目使用的主要框架或库。附加组件和插件则应该放在致谢一节中。下面是一些例子。 + +* [Next.js](https://nextjs.org/) +* [React.js](https://reactjs.org/) +* [Vue.js](https://vuejs.org/) +* [Angular](https://angular.io/) +* [Svelte](https://svelte.dev/) +* [Laravel](https://laravel.com) +* [Bootstrap](https://getbootstrap.com) +* [JQuery](https://jquery.com) + +

(返回顶部)

+ + + + +## 开始 + +这是一份在本地构建项目的指导的例子。 +要获取本地副本并且配置运行，你可以按照下面的示例步骤操作。 + +### 依赖 + +这只是一个列出软件依赖和安装方法的例子。 +* npm + ```sh + npm install npm@latest -g + ``` + +### 安装 + +_下面是一个指导你的受众如何安装和配置你的应用的例子。这个模板不需要任何外部依赖或服务。_ + +1. 在 [https://example.com](https://example.com) 获取一个免费的 API Key。 +2. 克隆本仓库 + ```sh + git clone https://github.com/your_username_/Project-Name.git + ``` +3. 安装 NPM 包 + ```sh + npm install + ``` +4. 在 `config.js` 中填写你的 API + ```js + const API_KEY = '填写你的 API'; + ``` + +

(返回顶部)

+ + + + +## 使用方法 + +在这里你可以展示项目的使用方法。把附加的截图、代码示例和演示放在这里也很不错。你也可以用链接引用其他资源。 + +_转到 [文档](https://example.com) 查看更多示例_ + +

(返回顶部)

+ + + + +## 路线图 + +- [x] 添加更新日志 +- [x] 添加「返回顶部」链接 +- [ ] 添加额外的模板和示例 +- [ ] 添加「组件」文档，以便更容易复制和粘贴各个部分 +- [ ] 多语种支持 + - [x] 中文 + - [ ] 西班牙语 + +到 [open issues](https://github.com/othneildrew/Best-README-Template/issues) 页查看所有请求的功能 （以及已知的问题）。 + +

(返回顶部)

+ + + + +## 贡献 + +贡献让开源社区成为了一个非常适合学习、启发和创新的地方。你所做出的任何贡献都是**受人尊敬**的。 + +如果你有好的建议，请复刻（fork）本仓库并且创建一个拉取请求（pull request）。你也可以简单地创建一个议题（issue），并且添加标签「enhancement」。不要忘记给项目点一个 star！再次感谢！ + +1. 复刻（Fork）本项目 +2. 创建你的 Feature 分支 (`git checkout -b feature/AmazingFeature`) +3. 提交你的变更 (`git commit -m 'Add some AmazingFeature'`) +4. 推送到该分支 (`git push origin feature/AmazingFeature`) +5. 创建一个拉取请求（Pull Request） + +

(返回顶部)

+ + + + +## 许可证 + +根据 MIT 许可证分发。打开 [LICENSE.txt](LICENSE.txt) 查看更多内容。 + + +

(返回顶部)

+ + + + +## 联系我们 + +你的名字 - [@your_twitter](https://twitter.com/your_username) - email@example.com + +项目链接: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) + +

(返回顶部)

+ + + + +## 致谢 + +在这里列出你觉得有用的资源，并以此致谢。我已经添加了一些我喜欢的资源，以便你可以快速开始！ + +* [Choose an Open Source License](https://choosealicense.com) +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) +* [Malven's Grid Cheatsheet](https://grid.malven.co/) +* [Img Shields](https://shields.io) +* [GitHub Pages](https://pages.github.com) +* [Font Awesome](https://fontawesome.com) +* [React Icons](https://react-icons.github.io/react-icons/search) + +

(返回顶部)

+ + + + + +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/othneildrew +[product-screenshot]: images/screenshot.png \ No newline at end of file