1 README作用
- 声明版权相关问题;
- 描述框架代码的作用;
- 告诉读者如何使用这个框架;
- 框架的基本操作过程等;
- 写框架的时候建议一定要有个README。
2 如何写README
思路如下:
- 版权声明
- 框架描述
- 代码结构
- 技术栈
- 框架设计
- 预期结果
- 执行流程
3 框架结构完善
- 在这之前先完善剩余的框架内容:
①在项目根目录下创建一个目录,名为file
,用于存放项目的各种文件和图片;
②在项目根目录下创建一个文件,名为README.md
,用于描述项目的README
- 如下:
posted @
2021-03-09 18:22
虫无涯
阅读(
4)
评论()
编辑
收藏
举报
来源