背景:
往往我们在git写代码的时候,需要用到说明文档,如readme文件。
当然readme文件使用txt文件简单明了,但美中不足,不能添加一些富文本内容。这时候可以考虑doc文档或者md等文件,由于我本身用的是mbp,没有内置office软件,所以更倾向于使用md
1.通过pycharm新建readme.md文件。
2.在csdn的文档发布中新建文档并点击“使用MD编辑器”(如果熟练使用md语法请略过),输入要编辑的内容,并复制到新建的md文件中。
3.在项目目录下新建pictures文件夹,并将图片文件放到文件夹(建议命名文件夹的时候不要用1,2,3等,免得编辑过程中混乱)
4.引用该文件夹下的图片文件,效果如图
![Test_and_Report_information](./pictures/Test_and_Report_information.png)
5.将上述文件夹通过git add 加到临时仓库,通过git commit,git push上传到远程仓库即可