GitHub 上有很多优秀的 README 模板，但我没找到一个适合我需求的，所以我创建了这个增强版。我想要创建一个 README 模板，它能优秀到成为你的最后一个 README 模板 —— 我认为这就是你所需要的。
以下是原因：
- 你应该把时间用在项目的「刀刃」上，也就是专注于解决问题本身上
- 你不应该一遍又一遍地做重复的工作，比如每次都从头编写一个 README
- 你应该在未来的生活中始终遵循 DRY 原则 😄
当然，没有一个模板可以满足所有项目，因为你的需求可能与众不同。所以我们会在未来添加更多内容。你也可以通过复刻（fork）本仓库并且创建一个拉取请求（pull request）或者创建议题（issue）来向我们提出建议。感谢所有帮助我们扩充本模板的贡献者！
使用 BLANK_README_zh.md 来开始。
(返回顶部)
你应该在这里列出项目使用的主要框架或库。附加组件和插件则应该放在致谢一节中。下面是一些例子。
(返回顶部)
这是一份在本地构建项目的指导的例子。 要获取本地副本并且配置运行，你可以按照下面的示例步骤操作。
这只是一个列出软件依赖和安装方法的例子。
- npm
npm install npm@latest -g
下面是一个指导你的受众如何安装和配置你的应用的例子。这个模板不需要任何外部依赖或服务。
- 在 https://example.com 获取一个免费的 API Key。
- 克隆本仓库
git clone https://github.com/your_username_/Project-Name.git
- 安装 NPM 包
npm install
- 在
config.js中填写你的 APIconst API_KEY = "填写你的 API";
(返回顶部)
在这里你可以展示项目的使用方法。把附加的截图、代码示例和演示放在这里也很不错。你也可以用链接引用其他资源。
转到 文档 查看更多示例
(返回顶部)
- 添加更新日志
- 添加「返回顶部」链接
- 添加额外的模板和示例
- 添加「组件」文档，以便更容易复制和粘贴各个部分
- 多语种支持
- 中文
- 西班牙语
到 open issues 页查看所有请求的功能 （以及已知的问题）。
(返回顶部)
贡献让开源社区成为了一个非常适合学习、启发和创新的地方。你所做出的任何贡献都是受人尊敬的。
如果你有好的建议，请复刻（fork）本仓库并且创建一个拉取请求（pull request）。你也可以简单地创建一个议题（issue），并且添加标签「enhancement」。不要忘记给项目点一个 star！再次感谢！
- 复刻（Fork）本项目
- 创建你的 Feature 分支 (
git checkout -b feature/AmazingFeature) - 提交你的变更 (
git commit -m 'Add some AmazingFeature') - 推送到该分支 (
git push origin feature/AmazingFeature) - 创建一个拉取请求（Pull Request）
(返回顶部)
根据 MIT 许可证分发。打开 LICENSE.txt 查看更多内容。
(返回顶部)
你的名字 - @your_twitter - [email protected]
项目链接: https://github.com/your_username/repo_name
(返回顶部)
在这里列出你觉得有用的资源，并以此致谢。我已经添加了一些我喜欢的资源，以便你可以快速开始！
- Choose an Open Source License
- GitHub Emoji Cheat Sheet
- Malven's Flexbox Cheatsheet
- Malven's Grid Cheatsheet
- Img Shields
- GitHub Pages
- Font Awesome
- React Icons
(返回顶部)