1 Star 2 Fork 0

Jax Young / Best-README-Template-zh

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Best-README-Template-zh

让你快速开始构建项目的最佳 README 模板!
浏览文档 »

查看 Demo · 反馈 Bug · 请求新功能

目录
  1. 关于本项目
  2. 开始
  3. 使用方法
  4. 路线图
  5. 贡献
  6. 许可证
  7. 联系我们
  8. 致谢

关于本项目

产品截图

GitHub 上有很多优秀的 README 模板,但我没找到一个适合我需求的,所以我创建了这个增强版。我想要创建一个 README 模板,它能优秀到成为你的最后一个 README 模板 —— 我认为这就是你所需要的。

以下是原因:

  • 你应该把时间用在项目的「刀刃」上,也就是专注于解决问题本身上
  • 你不应该一遍又一遍地做重复的工作,比如每次都从头编写一个 README
  • 你应该在未来的生活中始终遵循 DRY 原则 :smile:

当然,没有一个模板可以满足所有项目,因为你的需求可能与众不同。所以我们会在未来添加更多内容。你也可以通过复刻(fork)本仓库并且创建一个拉取请求(pull request)或者创建议题(issue)来向我们提出建议。感谢所有帮助我们扩充本模板的贡献者!

使用 BLANK_README_zh.md 来开始。

(返回顶部)

构建工具

你应该在这里列出项目使用的主要框架或库。附加组件和插件则应该放在致谢一节中。下面是一些例子。

(返回顶部)

开始

这是一份在本地构建项目的指导的例子。 要获取本地副本并且配置运行,你可以按照下面的示例步骤操作。

依赖

这只是一个列出软件依赖和安装方法的例子。

  • npm
    npm install npm@latest -g

安装

下面是一个指导你的受众如何安装和配置你的应用的例子。这个模板不需要任何外部依赖或服务。

  1. https://example.com 获取一个免费的 API Key。
  2. 克隆本仓库
    git clone https://github.com/your_username_/Project-Name.git
  3. 安装 NPM 包
    npm install
  4. config.js 中填写你的 API
    const API_KEY = '填写你的 API';

(返回顶部)

使用方法

在这里你可以展示项目的使用方法。把附加的截图、代码示例和演示放在这里也很不错。你也可以用链接引用其他资源。

转到 文档 查看更多示例

(返回顶部)

路线图

  • 添加更新日志
  • 添加「返回顶部」链接
  • 添加额外的模板和示例
  • 添加「组件」文档,以便更容易复制和粘贴各个部分
  • 多语种支持
    • 中文
    • 西班牙语

open 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 查看更多内容。

(返回顶部)

联系我们

你的名字 - @your_twitter - email@example.com

项目链接: https://github.com/your_username/repo_name

(返回顶部)

致谢

在这里列出你觉得有用的资源,并以此致谢。我已经添加了一些我喜欢的资源,以便你可以快速开始!

(返回顶部)

MIT License Copyright (c) 2021 Othneil Drew Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

你需要的最佳 README 模板,包含中文版! Fork from https://github.com/othneildrew/Best-README-Template 展开 收起
其他
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/Jaxvanyang/Best-README-Template-zh.git
git@gitee.com:Jaxvanyang/Best-README-Template-zh.git
Jaxvanyang
Best-README-Template-zh
Best-README-Template-zh
zh

搜索帮助

344bd9b3 5694891 D2dac590 5694891