如何写一个完美的readme

345 阅读1分钟
可以由以下几个作为切入口:


  1. 项目背景  项目需求
  2. 安装、配置环境  git clone ****    git pull origin master   pip install -r requirements.txt、安装环境,启动命令、目录结构、代理配置(nginx)、supervisor、crontab
  3. 使用 接口都有哪些、并包含哪些功能 
  4. 相关项目(可选) 是否有配套的项目与其交叉使用
  5. 主要项目负责人  
  6. 参与贡献方式   都应用了哪些方法