育才学习网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
用markdown语法写GitHub上README文件
作者 SHyH5
这篇文章是本人平时的一些笔记，可能会有很多人写过相关的东西，而且更为全面。目的只是分享一些自己平时的东西，勿喷！！！！
README文件
README文件可能大家都不会陌生，在我们上传一些自己的工程文件到GitHub时，附加的一个说明文档，会显示在仓库的详情中。使用markDown语法编写可以让其看起来更加清晰明朗一些。
具体的相关语法说明
readme文件的创建和编辑在这里就不多介绍了，相信使用过git的朋友们应该不会陌生。下面是一些常用的语法：
1.标题
首先是大标题，大标题是在作为标题的文字下面添加=号，个数不限；
其次是中标题，中标题在作为标题的文字下面添加-号，个数不限；
最后是各级小标题，分为六级，#号开头 ，每多一级多一个#号，比如：一级标题是#，二级标题是##，以此类推下去。下面是相关的效果展示：
大标题
中标题
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
+++++++手动分割线+++++++++
2.文本
首先是普通文本，文本主要是换行符，"< br >；"（去掉空格）或者是双空格加回车，如下：
这是一条可以换行的话，
这里是使用换行符换行。
这里是使用双空格加回车换行
然后是单行和多行文本， 使用两个Tab符实现单行文本；多行文本和单行文本异曲同工，只要在每行行首加两个Tab，比如
hello,swift
亲爱的领导：
你好！
再见
最后是文本的格式化和插入：
字体高亮：
把需要设置的字体用包围，是Tab上方，数字1左边的按键。如下：
窗前明月光，疑是地上霜
粗体和斜体：
用两个 星号 包含一段文本就是粗体的语法，用一个星号包含一段文本就是斜体的语法。
举头望明月，低头思故乡
引用：
在引用的句子前面加上 >； 号即可：
静夜思
窗前明月光，
疑是地上霜。
举头望明月，
低头思故乡。
3.readme.txt的文件说明
Readme.txt 是软件的说明文档，并非系统文件，但不排除病毒伪装成Readme.txt来达到特定目的，如果发现记事本或写字板打开的Readme.txt为乱码且或开头字符为'MZ' 则说明此Readme.txt为伪装的文件，请使用杀毒软件扫描系统并删除此文件！
转载请注明出处育才学习网 » readme文件怎么写