1.python的readme怎么写

了解一个项目，恐怕首先都是通过其Readme文件了解信息。如果你以为Readme文件都是随便写写的那你就错了。github,oschina Git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的。称之为Markdown语法。基本规则如下：

Markdown 语法速查表

1 标题与文字格式

标题

# 这是 H1

## 这是 H2

###### 这是 H6

文字格式

**这是文字粗体格式**

*这是文字斜体格式*

~~在文字上添加删除线~~

2 列表

无序列表

* 项目1

* 项目2

* 项目3

有序列表

1. 项目1

2. 项目2

3. 项目3

* 项目1

* 项目2

3 其它

图片

！[图片名称]（mage.png）

链接

[链接名称]（）

引用

>； 第一行引用文字

>； 第二行引用文字

水平线

***

代码

``

代码块高亮

```ruby

def add(a, b)

return a + b

end

```

表格

表头 | 表头

------------- | -------------

单元格内容 | 单元格内容

单元格内容l | 单元格内容

如果直接记语法，那似乎困难了些。这里OneCoder推荐两个Markdown的编辑器。

2.github的readme怎么写

好的readme，如何才算好，一定要有高逼格，好吧，中文不够国际化，一定要有英文版本首先logo很重要放在最上面，如meolu/walle-web · GitHub，然后起一个最耍帅的名字，如meolu/walden · GitHub:Walden 最适合东半球同学使用的文档框架。

最重要的，一定要有一个官方主页介绍，不求漂亮、高大上，至少做得大方得体，瓦尔登官方主页：Walden 瓦尔登。最好为它申请一个专业的域名，如瓦力官方主页：walle-web.io,.io域名比.com贵太多了：（ 不过，好马配好鞍，谁让它是我的理想寄托，值！介绍当然是少不了，这块可高大上，可幽默，看个人文笔了，目前我还没想好一套超酷的，先等着。

对于技术的readme，一定要各种icon:travis、scrutinizer、packagist这些标配至于什么安装，快速开始，功能列表这不啰嗦了，然后就是尽量给个截图或者gif，吸引兴趣，让用户看到完成之后的样子。