本文为 Android著名开源库的简版实现 中的 ${简版开源库} 的设计与实现
原始开源库: ${原始开源库名称}
作者:作者用户名,开发状态:完成/未完成,校对者:等待管理员填写,校对状态:未开始
建议大家看下 SimpleNet,了解应该写到什么程度,以及类似流程图和总体设计该怎么做。当然,如果你只想写README.md一篇介绍,那么该文档中必须包含详细的设计与源码实现介绍,阐述其核心原理。如果你的README.md只是一篇介绍性文档,那么后续必须增加其他阐述核心原理的其他文档。
复制一份到自己的项目文件夹下,然后根据自己项目替换掉 ${} 内容,删掉本行及上面两行。
功能介绍,包括功能或优点等
整个库分为哪些模块及模块之间的调用关系。
- 如大多数图片缓存会分为 Loader 和 Processer 等模块。
- 可使用 Google Drawing、Visio、StarUML 等工具完成,其他工具推荐??
- 非所有项目必须,不需要的请先在群里反馈。
主要功能流程图
- 如 Retrofit、Volley 的请求处理流程,Android-Universal-Image-Loader 的图片处理流程图
- 可使用 Google Drawing、Visio、StarUML 等工具完成,其他工具推荐??
- 非所有项目必须,不需要的请先在群里反馈
类及其主要函数功能介绍、核心功能流程图,流程图可使用 Google Drawing、Visio、StarUML。
类关系图,类的继承、组合关系图,可是用 StarUML 工具。
##5. 杂谈 该项目存在的问题、可优化点及类似功能项目对比等,非所有项目必须。
写完相关内容之后到开发群告知管理员,管理员安排相关人员进行审核,审核通过之后即可。