最近在寫 GitHub 上的 README，發現這個東西好像每個人的寫法都不太一樣，於是稍微整理了一下自己覺得大概要包含哪些內容。

Motivation

顧名思義就是簡介一下為什麼會有這個專案，以及這個專案大概在做什麼，解決了什麼問題。最好是三到五句話講出重點，不然很多人看到落落長的文章可能就跳過了 XD

Getting Started / Installation

如何快速地開始使用這個專案，通常會包含安裝以及環境設定等等。

Example / Demo

一個簡單有力的範例可以讓大家更容易了解這個專案在做什麼，也有人會將這段與 Getting Started 整合在一起。基本上我在 survey 任何東西都是先找這段來看，所以可以放越前面越好。如果可以的話，提供一個線上的 Demo 也是很好的選擇。

簡單來說就是，大专栏  How to Write a README on GitHubhref="http://i.imgur.com/qp3jo3H.jpg">Show Me the Code!

Overview

列出這個專案使用到哪些 3rd party 的工具或是 library。這可能會是開發者在選擇上一個重要的參考依據。

API Reference

這邊開始就進入比較詳細的設定。包含提供哪些 API 可以使用，或是一些客製化的選項。

Development / Tests

如何進行開發，或是測試。

Contributors

列出這個專案的主要貢獻者以及 GitHub 或是 Twitter 帳號，讓大家知道有 bug 要找誰解。

License

這個專案使用的 License。

根據專案性質或是其他狀況，可能會多多少少有些不同。不過只要大致上照這個方向去寫，就可以寫出一個像樣的 README 惹 XD

參考資料：https://gist.github.com/jxson/1784669

How to Write a README on GitHub的更多相关文章

  1. 搭通自己的电脑与GitHub的传输通道

    一.远程仓库怎么玩 1. 自己搭建一个运行Git的服务器 Git是分布式版本控制系统,同一个Git仓库,可以分布到不同的机器上,但肯定有一台机器有着最原始的版本库,然后别的机器来克隆这个原始版本库,这 ...

  2. 如何搭建一个独立博客——简明Github Pages与Hexo教程

    摘要:这是一篇很详尽的独立博客搭建教程,里面介绍了域名注册.DNS设置.github和Hexo设置等过程,这是我写得最长的一篇教程.我想将我搭建独立博客的过程在一篇文章中尽可能详细地写出来,希望能给后 ...

  3. Github使用技巧总结

    <config> PyCharm与GitHub配置使用总结 <readme> 在github的readme添加图片 github readme写法 GitHub上README. ...

  4. GitHub 风格的 Markdown 语法

    GitHub 风格的 Markdown 语法 [译] GitHub 风格的 Markdown 语法 Original: GitHub Flavored Markdown - GitHub Help T ...

  5. vuepress-theme-reco + Github Actions 构建静态博客，部署到第三方服务器

    最新博客链接 Github链接 查看此文档前应先了解,vuepress基本操作 参考官方文档进行配置: vuepress-theme-reco VuePress SamKirkland / FTP-D ...

  6. 微信开发者工具集成GitHub，多人协调开发，上传拉取等

    一,准备环境 1,提前安装git环境和GitHub做集成,不做多解释: 1,准备微信项目代码: 2,创建GitHub仓库: 二,创建GitHub仓库 1,创建一个空的GitHub仓库,不要任何文件和不 ...

  7. Github上的沙雕项目，玩100遍都不够

    这段时间大家在家自我隔离.居家办公憋坏了吧.为了打发这种无聊的生活,我决定拿出我在github上珍藏多年的沙雕项目,让大家在无聊的时候可以打发时间. Github作为互联网上最大的开源社区,一直备受程 ...

  8. jQuery2.x源码解析(构建篇)

    jQuery2.x源码解析(构建篇) jQuery2.x源码解析(设计篇) jQuery2.x源码解析(回调篇) jQuery2.x源码解析(缓存篇) 笔者阅读了园友艾伦 Aaron的系列博客< ...

  9. [转] nodemon 基本配置与使用

    在开发环境下,往往需要一个工具来自动重启项目工程,之前接触过 python 的 supervisor,现在写 node 的时候发现 supervisior 在很多地方都有他的身影,node 也有一个 ...

随机推荐

  1. Spring加载xml配置文件的方式

    梳理Spring的流程 xml是最常见的spring 应用系统配置源.Spring中的几种容器都支持使用xml装配bean,包括: XmlBeanFactory,ClassPathXmlApplica ...

  2. TPO2-3 Early Cinema

    Edison was more interested in the sale of Kinetoscopes(for roughly $1,000 apiece)to these parlors th ...

  3. ios 获取app版本号

    let infoDictionary = Bundle.main.infoDictionary!let appversion = infoDictionary["CFBundleShortV ...

  4. Linux Centos下MySQL主从Replication同步配置（一主一从）

    MySQL 主从复制概念MySQL 主从复制是指数据可以从一个MySQL数据库服务器主节点复制到一个或多个从节点.MySQL 默认采用异步复制方式,这样从节点不用一直访问主服务器来更新自己的数据,数据 ...

  5. [Algo] 281. Remove Spaces

    Given a string, remove all leading/trailing/duplicated empty spaces. Assumptions: The given string i ...

  6. PAT甲级——1011 World Cup Betting

    PATA1011 World Cup Betting With the 2010 FIFA World Cup running, football fans the world over were b ...

  7. .net core ioc

    -------------------------------------- 2. ---------------------------- -----------aop

  8. Excel-DNA项目只用1个文件实现Ribbon CustomUI和CustomTaskpane定制【C#版】

    Excel-DNA项目中的自定义功能区和自定义任务窗格需要用到各种命名空间.添加所需文件,才能实现.后来我发现可以把所有代码都写在Class1.cs这个默认文件中. 大家可以在Visual Studi ...

  9. 网页元素检测工具：Spy_for_InternetExplorer下载地址

    本工具用于实时查看IE浏览器中打开的网页中元素的信息.支持iframe.frame框架. 下载地址: Spy_for_InternetExplorer.rar

  10. cannot be found on object of type xx.CacheExpressionRootObject

    0 环境 系统环境:win10 编辑器:IDEA 1 前言->环境搭建 1-1 pom依赖 <?xml version="1.0" encoding="UTF ...