如何规范写出 Python 的 Github 文件

README.md

README.md 基本介绍

README.md文件是用Markdown写成的文件。README.md是为了让读者最快搞懂这个项目的价值（你做了什么），如何去使用这个项目，以及这个项目中的重要信息。
因此，README.md一般包括以下几个方面：

1. 项目的整体介绍，解决了什么问题

2. 整个项目所用的环境，所有子模块的描述 和 库的描述

3. 如何安装，配置环境; 如何运行该程序

4. 一些相关文档的信息

5. 作者列表

6. 许可信息

Markdown 介绍：

markdown语法介绍
Linux 上 10 个最好的 Markdown 编辑器
我使用harropad进行Markdown编辑。
debian安装包安装：

sudo dpkg -i haroopad-v0.13.1-x64.deb

Markdown书写的的风格传统：
* 如果用英文写的文档，只用 ASCII
* 如果可能写不同语言，比如README.ja
* 每行少于 80 个字符
* 段落之间空行
* 标题下划线

READ.md详细介绍

程序的安装

为了更方便的安装，一般使用yml文件，将需要用到的安装包放进去，然后通过yml建立anaconda的虚拟环境。

# 将已有anaconda环境 创建成 environment.yml文件
conda env export > environment.yaml

# 在其他电脑上上通过 environment.yml建立 anaconda环境
# 将创建和yml文件中相同姓名的环境
conda env create -f environment.yaml

# 在已有的anaconda环境中更新，安装yml文件中的安装包
source activate env_name
conda env update --file environment.yaml

yml文件的内容：

name: 虚拟环境名
channels:
  - pytorch
  - defaults
  - 还是使用国内地清华源、科大源等
dependencies:
  - 包名=版本号
  - pip:(使用pip 进行安装的一些包)
    - 包名=版本号

yml文件语法学习

Setup 打包

README.md和yml文件可以实现环境和依赖项的构建， 而setup.py则会实现对于代码的打包，通过打包，可以将你写好的代码进行打包成模块。其他人只需要下载这个模块，然后将这个模块安装在自己电脑上，就可以直接调用该模块中的函数和程序。 因此，打包成为了分享自己程序不可或缺的一步。

使用setuptools工具对代码进行打包

文件的结构

我们在将代码打包时，对于代码的结构有一定的要求。

另外，为了更好的使用打包，我们不仅要使用setup.py，还可以同时使用MANIFEST.in 指定文件清单，当时非代码数据的遗漏。
https://www.cnblogs.com/lands-ljk/p/5880483.html
https://zhuanlan.zhihu.com/p/276461821
https://python-packaging-zh.readthedocs.io/zh_CN/latest/non-code-files.html
https://www.cnblogs.com/anliven/p/9840583.html

将打包好的程序安装在电脑上